IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMManager(Signaling)

Instance Methods

(void) - addSignalingListener:
 
(void) - removeSignalingListener:
 
(NSString *) - invite:data:onlineUserOnly:offlinePushInfo:timeout:succ:fail:
 
(NSString *) - inviteInGroup:inviteeList:data:onlineUserOnly:timeout:succ:fail:
 
(void) - cancel:data:succ:fail:
 
(void) - accept:data:succ:fail:
 
(void) - reject:data:succ:fail:
 
(V2TIMSignalingInfo *) - getSignallingInfo:
 
(void) - addInvitedSignaling:succ:fail:
 

Protected Types

typedef void(^ V2TIMSignalingInfoSucc) (V2TIMSignalingInfo *signalInfo)
 

Member Typedef Documentation

◆ V2TIMSignalingInfoSucc

- (typedef void(^ V2TIMSignalingInfoSucc) (V2TIMSignalingInfo *signalInfo))
protected

Callback definition on get signaling information successfully

Method Documentation

◆ addSignalingListener:()

- (void) addSignalingListener: (addSignalingListener(listener:))  NS_SWIFT_NAME

Add the signaling listener

◆ removeSignalingListener:()

- (void) removeSignalingListener: (removeSignalingListener(listener:))  NS_SWIFT_NAME

Remove the signaling listener

◆ invite:data:onlineUserOnly:offlinePushInfo:timeout:succ:fail:()

- (NSString*) invite: (NSString *)  invitee
data: (NSString *)  data
onlineUserOnly: (BOOL)  onlineUserOnly
offlinePushInfo: (V2TIMOfflinePushInfo *)  offlinePushInfo
timeout: (int)  timeout
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

Invite someone

Parameters
inviteeInvitee's user ID
dataCustom data
timeoutTimeout duration, in seconds. If it is set to 0, the SDK does not perform timeout detection nor trigger the onInvitationTimeout callback.
onlineUserOnlyWhether the message can be received only by online users. If this field is set to true, the message can be received only by online users, and the invite operation does not produce historical messages (nor do subsequent cancel, accept, reject, and timeout operations of this invite operation). The invite operation does not produce historical messages (nor do subsequent cancel, accept, reject, and timeout operations of this invite operation).
offlinePushInfoOffline push information, where the desc field is required. The information specified by desc will be displayed by default during push.
Returns
inviteID Invitation ID. If the invitation fails, null is returned.

◆ inviteInGroup:inviteeList:data:onlineUserOnly:timeout:succ:fail:()

- (NSString*) inviteInGroup: (NSString *)  groupID
inviteeList: (NSArray *)  inviteeList
data: (NSString *)  data
onlineUserOnly: (BOOL)  onlineUserOnly
timeout: (int)  timeout
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

Invite certain users in the group

Parameters
groupIDID of the inviter's group
inviteeListList of invitees. Invitees specified by inviteeList must be in the group specified by groupID. Otherwise, the invitation fails.
timeoutTimeout duration, in seconds. If it is set to 0, the SDK does not perform timeout detection nor trigger the onInvitationTimeout callback.
onlineUserOnlyWhether the message can be received only by online users. If this field is set to true, the message can be received only by online users, and the invite operation does not produce historical messages (nor do subsequent cancel, accept, reject, and timeout operations of this invite operation). The invite operation does not produce historical messages (nor do subsequent cancel, accept, reject, and timeout operations of this invite operation).
Returns
inviteID Invitation ID. If the invitation fails, null is returned.
Attention
Currently, Group invitation does not support offline push. If you need offline push, you can send custom offline push messages to invitees separately.

◆ cancel:data:succ:fail:()

- (void) cancel: (NSString *)  inviteID
data: (NSString *)  data
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

The inviter canceled the invitation

Parameters
inviteIDInvitation ID
Attention
If all invitees have processed the current invitation (including timeout), the current invitation cannot be cancelled.

◆ accept:data:succ:fail:()

- (void) accept: (NSString *)  inviteID
data: (NSString *)  data
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

The invitee accepts the invitation

Attention
Users cannot accept only invitations that are not targeted at themselves. When receiving the onReceiveNewInvitation callback, check whether the current user is specified in inviteeList. If no, the current user cannot accept the invitation.

◆ reject:data:succ:fail:()

- (void) reject: (NSString *)  inviteID
data: (NSString *)  data
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

The invitee rejects the invitation

Attention
Users cannot reject only invitations that are not targeted at themselves. When receiving the onReceiveNewInvitation callback, check whether the current user is specified in inviteeList. If no, the current user cannot reject the invitation.

◆ getSignallingInfo:()

- (V2TIMSignalingInfo *) getSignallingInfo: (V2TIMMessage *)  msg

Get the signaling information

If onlineUserOnly is set to false in the invite operation, a custom message is generated for each signaling operation (including the invite, cancel, accept, reject, and timeout operations). The message will be delivered to users via V2TIMAdvancedMsgListener -> onRecvNewMessage and can be pulled by users via historical message pulling. If you want to customize the display text based on the signaling information, call the following API to get the signaling information.

Parameters
msgMessage object
Returns
V2TIMSignalingInfo Signaling information. If the value is nil, msg is not a signaling message.

◆ addInvitedSignaling:succ:fail:()

- (void) addInvitedSignaling: (V2TIMSignalingInfo *)  signallingInfo
succ: (V2TIMSucc)  succ
fail: (V2TIMFail)  fail 

Add invitation signaling (can be used for invitation signaling triggered by group offline push messages)

In offline push scenarios:

  • One-to-one invitation: if the invitee's app is killed and is started again when receiving an offline push, the user will receive the onReceiveNewInvitation callback if the invitation does not time out and receive the onInvitationTimeout callback if the invitation times out.
  • Group invitation: if the invitee's app is killed and is started again when receiving an offline push, the SDK cannot automatically sync the invitation signaling information. If you want to process the invitation in this scenario, contain the signaling information when sending the push message, parse the signaling information when receiving the push, and call addInvitedSignaling to proactively add the signaling information.

TUIKit implements offline push for audio/video calls based on this API. For details of the implementation method, see Enabling Audio/Video Calls

Attention
If the added signaling information already exists, the callback throws the ERR_SDK_SIGNALING_ALREADY_EXISTS error code.