TWCConversation Class Reference

Inherits from NSObject
Declared in TWCConversation.h

Overview

Object that represents a current or pending conversation

  participants

An array of participants in the current conversation.

@property (nonatomic, readonly, strong, nonnull) NSArray<TWCParticipant*> *participants

Discussion

An array of participants in the current conversation.

Declared In

TWCConversation.h

  localMedia

Representation of the local video and audio stream

@property (nonatomic, strong, readonly, nullable) TWCLocalMedia *localMedia

Discussion

Representation of the local video and audio stream

Declared In

TWCConversation.h

  delegate

The delegate for this conversation.

@property (nonatomic, weak, nullable) id<TWCConversationDelegate> delegate

Discussion

The delegate for this conversation.

Declared In

TWCConversation.h

  sid

This conversation’s identifier

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

Discussion

This conversation’s identifier

Declared In

TWCConversation.h

– disconnect

Disconnect from this conversation.

- (BOOL)disconnect

Return Value

‘YES’ if success, ‘NO’ if failure.

Discussion

Disconnect from this conversation.

Declared In

TWCConversation.h

– disconnect:

Disconnect from this conversation.

- (BOOL)disconnect:(NSError *_Nullable *_Nullable)error

Parameters

error

The error encountered

Return Value

‘YES’ if disconnecected, ‘NO’ if error was encountered.

Discussion

Disconnect from this conversation.

Declared In

TWCConversation.h

– invite:error:

Invite an additional client to the conversation.

- (BOOL)invite:(nonnull NSString *)clientIdentity error:(NSError *_Nullable *_Nullable)error

Parameters

clientIdentity

The client identity to invite.
error

The error encountered

Return Value

‘YES’ if success, ‘NO’ if error was encountered.

Discussion

Invite an additional client to the conversation.

Declared In

TWCConversation.h

– inviteMany:error:

Invite additional clients to the conversation.

- (BOOL)inviteMany:(nonnull NSArray *)clientIdentities error:(NSError *_Nullable *_Nullable)error

Parameters

clientIdentities

The client identities.
error

The error encountered

Return Value

‘YES’ if success, ‘NO’ if error was encountered.

Discussion

Invite additional clients to the conversation.

Declared In

TWCConversation.h

– getParticipant:

Get participant with participant SID.

- (TWCParticipant *_Nullable)getParticipant:(nonnull NSString *)participantSID

Parameters

participantSID

The Participant SID.

Return Value

participant with participant SID. Returns nil if participant not found.

Discussion

Get participant with participant SID.

Declared In

TWCConversation.h