FMIceLinkWebSync4LeaveConferenceArgs Class Reference

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

Overview

Arguments for a client leaving an IceLink conference.

Other Methods

– conferenceChannel

Gets the conference channel.
- (NSString *)conferenceChannel

Discussion

Gets the conference channel.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– initWithConferenceChannel:

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

Parameters

conferenceChannel

The conference ID.

Discussion

Initializes a new instance of the FMIceLinkWebSync4LeaveConferenceArgs class.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

+ leaveConferenceArgsWithConferenceChannel:

Initializes a new instance of the FMIceLinkWebSync4LeaveConferenceArgs class.
+ (FMIceLinkWebSync4LeaveConferenceArgs *)leaveConferenceArgsWithConferenceChannel:(NSString *)conferenceChannel

Parameters

conferenceChannel

The conference ID.

Discussion

Initializes a new instance of the FMIceLinkWebSync4LeaveConferenceArgs class.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– onFailure

Gets the callback to invoke if the request fails.
- (FMIceLinkAction1<FMIceLinkWebSync4LeaveConferenceFailureArgs*> *)onFailure

Discussion

Gets the callback to invoke if the request fails.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– onSuccess

Gets the callback to invoke if the request succeeds.
- (FMIceLinkAction1<FMIceLinkWebSync4LeaveConferenceSuccessArgs*> *)onSuccess

Discussion

Gets the callback to invoke if the request succeeds.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setConferenceChannel:

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

Discussion

Sets the conference channel.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnFailure:

Sets the callback to invoke if the request fails.
- (void)setOnFailure:(FMIceLinkAction1<FMIceLinkWebSync4LeaveConferenceFailureArgs*> *)value

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnFailureBlock

Sets the callback to invoke if the request fails.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSync4LeaveConferenceFailureArgs *) ))setOnFailureBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnFailureBlock:

Sets the callback to invoke if the request fails.
- (void)setOnFailureBlock:(void ( ^ ) ( FMIceLinkWebSync4LeaveConferenceFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnSuccess:

Sets the callback to invoke if the request succeeds.
- (void)setOnSuccess:(FMIceLinkAction1<FMIceLinkWebSync4LeaveConferenceSuccessArgs*> *)value

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnSuccessBlock

Sets the callback to invoke if the request succeeds.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkWebSync4LeaveConferenceSuccessArgs *) ))setOnSuccessBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setOnSuccessBlock:

Sets the callback to invoke if the request succeeds.
- (void)setOnSuccessBlock:(void ( ^ ) ( FMIceLinkWebSync4LeaveConferenceSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– setUnlinkAllOnSuccess:

Sets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. Defaults to true.
- (void)setUnlinkAllOnSuccess:(bool)value

Discussion

Sets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. Defaults to true.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

– unlinkAllOnSuccess

Gets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. Defaults to true.
- (bool)unlinkAllOnSuccess

Discussion

Gets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. Defaults to true.

Declared In

FMIceLinkWebSync4LeaveConferenceArgs.h

Other Methods

– init

- (instancetype)init

Declared In

FM.h