FMIceLinkWebSync4JoinConferenceArgs Class Reference

Inherits from FMWebSyncBaseInputArgs : FMWebSyncExtensible : FMDynamic : FMSerializable : NSObject
Declared in FMIceLinkWebSync4JoinConferenceArgs.h
FMIceLinkWebSync4JoinConferenceArgs.m

Overview

Arguments for a client joining an IceLink conference.

Other Methods

– conferenceChannel

Gets the conference channel.
- (NSString *)conferenceChannel

Discussion

Gets the conference channel.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– initWithConferenceChannel:

Initializes a new instance of the FMIceLinkWebSync4JoinConferenceArgs class.
- (instancetype)initWithConferenceChannel:(NSString *)conferenceChannel

Parameters

conferenceChannel

The conference channel.

Discussion

Initializes a new instance of the FMIceLinkWebSync4JoinConferenceArgs class.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

+ joinConferenceArgsWithConferenceChannel:

Initializes a new instance of the FMIceLinkWebSync4JoinConferenceArgs class.
+ (FMIceLinkWebSync4JoinConferenceArgs *)joinConferenceArgsWithConferenceChannel:(NSString *)conferenceChannel

Parameters

conferenceChannel

The conference channel.

Discussion

Initializes a new instance of the FMIceLinkWebSync4JoinConferenceArgs class.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– onFailure

Gets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.
- (FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceFailureArgs*> *)onFailure

Discussion

Gets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– onReceive

Gets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.
- (FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceReceiveArgs*> *)onReceive

Discussion

Gets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– onRemoteClient

Gets the callback to invoke when a new remote client needs a connection.
- (FMIceLinkFunction1<FMIceLinkWebSync4PeerClient*,FMIceLinkConnection*> *)onRemoteClient

Discussion

Gets the callback to invoke when a new remote client needs a connection.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– onSuccess

Gets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.
- (FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceSuccessArgs*> *)onSuccess

Discussion

Gets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setConferenceChannel:

Sets the conference channel.
- (void)setConferenceChannel:(NSString *)value

Discussion

Sets the conference channel.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnFailure:

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.
- (void)setOnFailure:(FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceFailureArgs*> *)value

Discussion

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnFailureBlock

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSync4JoinConferenceFailureArgs *) ))setOnFailureBlock

Discussion

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnFailureBlock:

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.
- (void)setOnFailureBlock:(void ( ^ ) ( FMIceLinkWebSync4JoinConferenceFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails. See [FMIceLinkWebSync4JoinConferenceFailureArgs](../Classes/FMIceLinkWebSync4JoinConferenceFailureArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnReceive:

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.
- (void)setOnReceive:(FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceReceiveArgs*> *)value

Discussion

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnReceiveBlock

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSync4JoinConferenceReceiveArgs *) ))setOnReceiveBlock

Discussion

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnReceiveBlock:

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.
- (void)setOnReceiveBlock:(void ( ^ ) ( FMIceLinkWebSync4JoinConferenceReceiveArgs *))valueBlock

Discussion

Sets the callback to invoke when data is received on the channel. See [FMIceLinkWebSync4JoinConferenceReceiveArgs](../Classes/FMIceLinkWebSync4JoinConferenceReceiveArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnRemoteClient:

Sets the callback to invoke when a new remote client needs a connection.
- (void)setOnRemoteClient:(FMIceLinkFunction1<FMIceLinkWebSync4PeerClient*,FMIceLinkConnection*> *)value

Discussion

Sets the callback to invoke when a new remote client needs a connection.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnRemoteClientBlock

Sets the callback to invoke when a new remote client needs a connection.
- (void ( ^ ) ( FMIceLinkConnection *( ^ ) ( FMIceLinkWebSync4PeerClient *) ))setOnRemoteClientBlock

Discussion

Sets the callback to invoke when a new remote client needs a connection.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnRemoteClientBlock:

Sets the callback to invoke when a new remote client needs a connection.
- (void)setOnRemoteClientBlock:(FMIceLinkConnection *( ^ ) ( FMIceLinkWebSync4PeerClient *))valueBlock

Discussion

Sets the callback to invoke when a new remote client needs a connection.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnSuccess:

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.
- (void)setOnSuccess:(FMIceLinkAction1<FMIceLinkWebSync4JoinConferenceSuccessArgs*> *)value

Discussion

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnSuccessBlock

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSync4JoinConferenceSuccessArgs *) ))setOnSuccessBlock

Discussion

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setOnSuccessBlock:

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.
- (void)setOnSuccessBlock:(void ( ^ ) ( FMIceLinkWebSync4JoinConferenceSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds. See [FMIceLinkWebSync4JoinConferenceSuccessArgs](../Classes/FMIceLinkWebSync4JoinConferenceSuccessArgs.html) for callback argument details.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setUnlinkExistingOnUserJoin:

Sets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.
- (void)setUnlinkExistingOnUserJoin:(bool)value

Discussion

Sets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– setUnlinkOnUserLeave:

Sets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.
- (void)setUnlinkOnUserLeave:(bool)value

Discussion

Sets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– unlinkExistingOnUserJoin

Gets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.
- (bool)unlinkExistingOnUserJoin

Discussion

Gets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

– unlinkOnUserLeave

Gets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.
- (bool)unlinkOnUserLeave

Discussion

Gets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.

Declared In

FMIceLinkWebSync4JoinConferenceArgs.h

Other Methods

– init

- (instancetype)init

Declared In

FM.h