MXMeetSession Class Reference

Inherits from NSObject
Declared in MXMeetSession.h

Overview

The MXMeetSession class provides interfaces for interacting with meet sessions as well as user interface elements required by meet.

  meetId

Meet id of this session

@property (nonatomic, strong, readonly) NSString *meetId

Declared In

MXMeetSession.h

  participantList

An array containing all the participants of this meeting

@property (nonatomic, strong, readonly) NSArray<MXMeetParticipant*> *participantList

Declared In

MXMeetSession.h

  screenCaptureView

The window or view that user wants to share in the meeing. The default value is nil which means the main window is shared.

@property (nonatomic, strong, nullable) UIView *screenCaptureView

Declared In

MXMeetSession.h

  didTapInviteButton

A block to be executed when invite button is tapped.

@property (nonatomic, copy, nullable) void ( ^ ) ( MXMeetSession *session , id sender ) didTapInviteButton

Declared In

MXMeetSession.h

  didTapParticipantAvatar

A block to be executed when participants' avatars are tapped.

@property (nonatomic, copy, nullable) void ( ^ ) ( MXMeetSession *session , id sender , MXMeetParticipant *participant ) didTapParticipantAvatar

Declared In

MXMeetSession.h

  didTapEndOrLeaveMeetButton

A block to be executed when end or leave button is tapped.

@property (nonatomic, copy, nullable) void ( ^ ) ( MXMeetSession *session , id sender ) didTapEndOrLeaveMeetButton

Declared In

MXMeetSession.h

  delegate

The object acts as the delegate of this meet session.

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

Declared In

MXMeetSession.h

– inviteUsers:withCompletionHandler:

Invite users to join this meeting by specifing an array containing users to be invited.

- (void)inviteUsers:(NSArray<MXUserItem*> *)users withCompletionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

users

An array containing all users to be invited.
completionHandler

A block to be executed when the action completes.

Declared In

MXMeetSession.h

– inviteUsersWithOrgId:uniqueIds:completionHandler:

Invite users within a organization to join this meeting by specifing org id and unique ids

- (void)inviteUsersWithOrgId:(NSString *__nullable)orgId uniqueIds:(NSArray<NSString*> *)uniqueIds completionHandler:(void ( ^ __nullable ) ( NSError *__nullable errorOrNil ))completionHandler

Parameters

orgId

A string representing the org ID. Set nil if there is no one.
uniqueIds

An array containing unique IDs of those who will be invited.
completionHandler

A block to be executed when the action completes

Declared In

MXMeetSession.h

– presentMeetWindow

Present the meet window.

- (void)presentMeetWindow

Declared In

MXMeetSession.h

– endOrLeaveMeetSessionWithCompletionHandler:

End(If the current user is the host) or leave the meet session.

- (void)endOrLeaveMeetSessionWithCompletionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if the session is not in progress.

Declared In

MXMeetSession.h

– joinVoIPWithCompletionHandler:

Join VoIP in the meeting

- (void)joinVoIPWithCompletionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if no VoIP is found in this session. An error with code MXChatSDKErrorNotSupport will occurred if the device does not support VoIP or the request for VoIP is declined by the user.

Declared In

MXMeetSession.h

– leaveVoIP

Leave VoIP in the meeting. If the user has not joined VoIP, it will do nothing.

- (void)leaveVoIP

Declared In

MXMeetSession.h

– startSharingFileWithPath:completionHandler:

Start sharing a file.

- (void)startSharingFileWithPath:(NSString *)filePath completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

filePath

The local path of the file to be shared.
completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorNoPermission will occurred if the user is not the presenter. An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if the session is not in progress.

Declared In

MXMeetSession.h

– startSharingScreenWithCompletionHandler:

Start sharing the screen.

- (void)startSharingScreenWithCompletionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorNoPermission will occurred if the user is not the presenter. An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if the session is not in progress.

Declared In

MXMeetSession.h

– startSharingWhiteBoardWithCompletionHandler:

Start sharing white board.

- (void)startSharingWhiteBoardWithCompletionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorNoPermission will occurred if the user is not the presenter. An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if the session is not in progress.

Declared In

MXMeetSession.h

– startVideoWithCaptureSource:completionHandler:

Start video

- (void)startVideoWithCaptureSource:(AVCaptureDevicePosition)captureSource completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable errorOrNil ))completionHandler

Parameters

captureSource

The capture device used for video.
completionHandler

A block to be executed when the action completes.

Discussion

An error with code MXChatSDKErrorPreconditionNotSatisfied will occurred if video is not enabled in this session. An error with code MXChatSDKErrorNotSupport will occurred if the device does not support video or the request for video is declined by the user.

Declared In

MXMeetSession.h