TWCIncomingInvite Class Reference

Inherits from NSObject
Declared in TWCIncomingInvite.h

Overview

TWCIncomingInvite represents a request to join a Conversation.

  conversationSid

The unique server identifier of the Conversation you are invited to.

@property (nonatomic, copy, readonly, nullable) NSString *conversationSid

Discussion

The unique server identifier of the Conversation you are invited to.

This value can be very useful for debugging purposes.

Declared In

TWCIncomingInvite.h

  from

The identity of the inviter.

@property (nonatomic, copy, readonly, nonnull) NSString *from

Discussion

The identity of the inviter.

Declared In

TWCIncomingInvite.h

  participants

The participants who have been invited to, or have already joined the Conversation.

@property (nonatomic, copy, readonly, nonnull) NSArray *participants

Discussion

The participants who have been invited to, or have already joined the Conversation.

Declared In

TWCIncomingInvite.h

  status

The current status of the Invite.

@property (nonatomic, assign, readonly) TWCInviteStatus status

Discussion

The current status of the Invite.

When a TWCIncomingInvite is raised to your TwilioConversationClientDelegate its initial status will be TWCInviteStatusPending.

Declared In

TWCIncomingInvite.h

– acceptWithCompletion:

Accepts an invite with the default local media configuration.

- (void)acceptWithCompletion:(nonnull TWCInviteAcceptanceBlock)acceptHandler

Parameters

acceptHandler

The completion handler to be called when invite acceptance finishes.

Discussion

Accepts an invite with the default local media configuration.

Note: The default media configuration shares your microphone, but not the camera.

Declared In

TWCIncomingInvite.h

– acceptWithLocalMedia:completion:

Accepts an invite with a specific local media configuration.

- (void)acceptWithLocalMedia:(nonnull TWCLocalMedia *)localMedia completion:(nonnull TWCInviteAcceptanceBlock)acceptHandler

Parameters

localMedia

The local media object to share with participants.
acceptHandler

The completion handler to be called when invite acceptance finishes.

Discussion

Accepts an invite with a specific local media configuration.

Declared In

TWCIncomingInvite.h

– acceptWithLocalMedia:iceOptions:completion:

Accepts an invite with a specific local media configuration and custom ICE options.

- (void)acceptWithLocalMedia:(nonnull TWCLocalMedia *)localMedia iceOptions:(nonnull TWCIceOptions *)iceOptions completion:(nonnull TWCInviteAcceptanceBlock)acceptHandler

Parameters

localMedia

The local media object to share with participants.
iceOptions

The custom ICE configuration to use.
acceptHandler

The completion handler to be called when invite acceptance finishes.

Discussion

Accepts an invite with a specific local media configuration and custom ICE options.

Declared In

TWCIncomingInvite.h

– reject

Reject this invitation, sending a message indicating rejection to the requestor.

- (void)reject

Discussion

Reject this invitation, sending a message indicating rejection to the requestor.

Declared In

TWCIncomingInvite.h