MXClientChatDelegate Protocol Reference

Conforms to NSObject
Declared in MXClient.h

Overview

@protocol MXClientChatDelegate

The protocol define the delegates for notifying the calling application during the chat.

– popChatViewController:isDeleted:

Called when user press back button on chat view controller in case that isDeleted is NO. Or called when user press leave/delete button on chat setting view controller in case that isDeleted is YES. If this delegate is not be implemented, the chatViewController will be dismiss/pop automatically when user press back button.

- (void)popChatViewController:(UIViewController *_Nullable)chatViewController isDeleted:(BOOL)isDeleted

Declared In

MXClient.h

– onChatSessionUpdated:

Called when there are some update for chat.

- (void)onChatSessionUpdated:(MXChatSession *_Nullable)chatSession

Declared In

MXClient.h

– onChatSessionCreated:

Called when a new chat is created.

- (void)onChatSessionCreated:(MXChatSession *_Nullable)chatSession

Declared In

MXClient.h

– onChatSessionDeleted:

Called when an exist chat is deleted.

- (void)onChatSessionDeleted:(MXChatSession *_Nullable)chatSession

Declared In

MXClient.h

– presentInviteChatMembersViewController:binderID:

Called when 3rd party want to customize invite members to group chat if user press invite button in binder setting.

- (void)presentInviteChatMembersViewController:(UIViewController *_Nullable)presentingViewController binderID:(NSString *_Nullable)binderID

Declared In

MXClient.h

– presentChatMemberProfileViewController:uniqueID:

Called when user single tap the avatar in chat, or in the page comment, or try to view member’s profile in the chat setting view controller.

- (void)presentChatMemberProfileViewController:(UIViewController *_Nullable)presentingViewController uniqueID:(NSString *_Nullable)uniqueID

Declared In

MXClient.h

– presentBinderSettingViewController:

Called when 3rd party want to customize binder setting view controller if user try to open binder setting view controller via pressing “…” button.

- (void)presentBinderSettingViewController:(UIViewController *_Nullable)presentingViewController

Declared In

MXClient.h

– meetLauchViewController

return the customized meet lauch view controller that the 3rd party want to attach.

- (UIViewController *)meetLauchViewController

Declared In

MXClient.h

– presentAddFilesViewController:

Called when 3rd party want to customize add files view controller if user try to add files via pressing “+” button. If this delegate is not be implemented, the default “+” panel will be showed.

- (void)presentAddFilesViewController:(UIViewController *_Nullable)presentingViewController

Declared In

MXClient.h

– presentMoreFilesViewController:

Called when 3rd party want to add files if user try to add files via pressing “…” button in default “+” panel. If this delegate is not be implemented, the “…” button will not be showed in default “+” panel.

- (void)presentMoreFilesViewController:(UIViewController *_Nullable)presentingViewController

Declared In

MXClient.h

– numberOfChatMemberExceeded

Called when the number of chat members exceeded the limited number.

- (void)numberOfChatMemberExceeded

Declared In

MXClient.h

– userStorageExceeded

Called when the user’s storage exceeded the limited size.

- (void)userStorageExceeded

Declared In

MXClient.h

– sizeOfFileExceeded:

Called when the size of uploading file exceeded the limited size(byte).

- (void)sizeOfFileExceeded:(unsigned long long)maxSize

Declared In

MXClient.h

– shareLink:downloadLink:

Called when user press share menu/button. If this delegate is not be implemented, the default share menu will pop up.

- (void)shareLink:(NSString *_Nullable)shareLink downloadLink:(NSString *_Nullable)downloadLink

Declared In

MXClient.h

– binderEmailHost

Not recommended for use, If the 3rd party want customize the binder email host, please contact us at first. Called when app need get the binder email address. Return the customized binder email host. If this delegate is not be implemented, we will use the default binder email host.

- (nullable NSString *)binderEmailHost

Declared In

MXClient.h

– textMessageWillSend:

Called when the user press “send” button to send text message in chat. You can check the text message and return your modified text message.

- (nullable NSString *)textMessageWillSend:(NSString *_Nullable)textMessage

Declared In

MXClient.h

– supportParentGuard

Return NO if the 3rd party do not need parent guard. The default values is YES.

- (BOOL)supportParentGuard

Declared In

MXClient.h

– supportDuplicateBinder

Return NO if the 3rd party need hide “Duplicate Binder” option in binder setting. The default values is YES.

- (BOOL)supportDuplicateBinder

Declared In

MXClient.h

– hideSilentMessage

return YES if the 3rd party want to hide silent message selection in chat input box. The default value is NO.

- (BOOL)hideSilentMessage

Declared In

MXClient.h

– shouldDisableBinderCreationFeed

return YES if the 3rd party want to disable binder creation feed. The default value is NO.

- (BOOL)shouldDisableBinderCreationFeed

Declared In

MXClient.h

– supportSaveToAlbum

return NO if the 3rd party want to disable “Save to Album”. The default value is YES.

- (BOOL)supportSaveToAlbum

Declared In

MXClient.h

– presentInviteMeetAttendeesViewController:meetID:

Called when 3rd party want to customize invite attendees process if user press invite button in meet.

- (void)presentInviteMeetAttendeesViewController:(UIViewController *_Nullable)presentingViewController meetID:(NSString *_Nullable)meetID

Declared In

MXClient.h

– reinviteToMeetMenuDidPress:meetID:uniqueID:orgID:

Called when 3rd party want to customize reinvite attendees process if user press reinvite menu in meet.

- (void)reinviteToMeetMenuDidPress:(UIViewController *_Nullable)presentingViewController meetID:(NSString *_Nullable)meetID uniqueID:(NSString *)uniqueID orgID:(NSString *)orgID

Declared In

MXClient.h

– shouldDisableMeetChat

Return YES if the 3rd party need hide chat panel in meet. The default value is NO.

- (BOOL)shouldDisableMeetChat

Declared In

MXClient.h

– shouldDisableMeetParticipantPanel

Return YES if the 3rd party need hide participant panel in meet. The default value is NO.

- (BOOL)shouldDisableMeetParticipantPanel

Declared In

MXClient.h

– supportMeetTelephony

Called when the user will join audio to ask whether using VOIP or telephony in meet. The default value is YES.

- (BOOL)supportMeetTelephony

Declared In

MXClient.h

– supportMeetVOIP

Called when the user will join audio to ask whether using VOIP or telephony in meet. The default value is YES.

- (BOOL)supportMeetVOIP

Declared In

MXClient.h

– supportAutoJoinVOIP

Return YES if the 3rd party need join VOIP automatically when start or join meet. The default values is NO.

- (BOOL)supportAutoJoinVOIP

Declared In

MXClient.h

– supportAttendeeJoinVOIPWithMuted

Return YES if the 3rd party need attendee’s VOIP is muted when attendee join VOIP in meet. The default values is NO.

- (BOOL)supportAttendeeJoinVOIPWithMuted

Declared In

MXClient.h

– supportAttendeeUnmuteBySelf

Return NO if the 3rd party need attendee can not unmute by himself in meet. The default values is YES.

- (BOOL)supportAttendeeUnmuteBySelf

Declared In

MXClient.h

– supportHostUnmuteAttendee

Return YES if the 3rd party need host can unmute attendees in meet. The default values is NO.

- (BOOL)supportHostUnmuteAttendee

Declared In

MXClient.h

– supportPresenterUnmuteAttendee

Return YES if the 3rd party need presenter can unmute attendees in meet. The default values is NO.

- (BOOL)supportPresenterUnmuteAttendee

Declared In

MXClient.h

– voipDidJoin

Called when voip is joined in meeting.

- (void)voipDidJoin

Declared In

MXClient.h

– voipDidLeave

Called when voip is left in meeting.

- (void)voipDidLeave

Declared In

MXClient.h

– supportMeetVideo

Return NO if the 3rd party need disable video in meet. The default values is YES.

- (BOOL)supportMeetVideo

Declared In

MXClient.h

– supportAttendeeActivateCamera

Return NO if the 3rd party need inactivate camera on attendee side in meet. The default values is YES.

- (BOOL)supportAttendeeActivateCamera

Declared In

MXClient.h

– supportAutoStartVideo

Return YES if the 3rd party need start video automatically when start or join meet. The default values is NO.

- (BOOL)supportAutoStartVideo

Declared In

MXClient.h

– videoDidJoin

Called when video is joined in meeting.

- (void)videoDidJoin

Declared In

MXClient.h

– videoDidLeave

Called when video is left in meeting.

- (void)videoDidLeave

Declared In

MXClient.h

– supportScreenShare

Return NO if the 3rd party need disable screen share in meet. The default values is YES.

- (BOOL)supportScreenShare

Declared In

MXClient.h

– supportDocumentShare

Return NO if the 3rd party need disable document share in meet. The default values is YES.

- (BOOL)supportDocumentShare

Declared In

MXClient.h

– screenCapture

Return the capture window or view when start screen share in meet. If this delegate is not be implemented, we will choose a window to capture.

- (nullable UIView *)screenCapture

Declared In

MXClient.h

– supportMeetRecording

Return NO if the 3rd party need disable recording in meet. The default value is YES.

- (BOOL)supportMeetRecording

Declared In

MXClient.h

– supportMeetAutoRecording

Return YES if the 3rd party need start recording automatically when start meet. The default value is NO.

- (BOOL)supportMeetAutoRecording

Declared In

MXClient.h

– meetRecordingPublicUrl:

Called to return the recording file url when meet is ending.

- (void)meetRecordingPublicUrl:(NSString *_Nullable)publicUrl

Declared In

MXClient.h

– supportClipMeetScreen

Return NO if the 3rd party need disable clip meet screen in meet. The default values is YES.

- (BOOL)supportClipMeetScreen

Declared In

MXClient.h

– supportSaveMeetFile

Return NO if the 3rd party need disable save meet file in meet. The default values is YES.

- (BOOL)supportSaveMeetFile

Declared In

MXClient.h

– supportBinderPage

Return NO if the 3rd party need disable add file from binder page. The default values is YES.

- (BOOL)supportBinderPage

Declared In

MXClient.h

– meetStarted:

Called when meet has been started in the chat UI.

- (void)meetStarted:(NSString *_Nullable)meetID

Declared In

MXClient.h

– meetEnded

Called when meet is ending.

- (void)meetEnded

Declared In

MXClient.h

– meetWillExpire:maxLength:remainingTime:

Called when meet will be expired in remaining time(second). The default value of remainingTime is 300(5 minutes).

- (void)meetWillExpire:(NSString *_Nullable)meetID maxLength:(unsigned long long)maxLength remainingTime:(unsigned long long)remainingTime

Declared In

MXClient.h

– meetExpired:maxLength:

Called when meet is expired. MaxLength(second) is the time lenght of meet.

- (void)meetExpired:(NSString *_Nullable)meetID maxLength:(unsigned long long)maxLength

Declared In

MXClient.h

– numberOfMeetMemberExceeded:

Called when the number of meet member exceeded the limited number.

- (void)numberOfMeetMemberExceeded:(NSInteger)maxNumber

Declared In

MXClient.h

– supportMeetFloatMode

Return NO if the 3rd party want to hide the collapse button on top bar in meet. The default value is YES.

- (BOOL)supportMeetFloatMode

Declared In

MXClient.h

– hideMeetLinkPanel

Return YES if the 3rd party need hide meet id and meet link in meet. The default value is NO.

- (BOOL)hideMeetLinkPanel

Declared In

MXClient.h

– hideMeetID

Return YES if the 3rd party need hide meet id in meet. The default value is NO.

- (BOOL)hideMeetID

Declared In

MXClient.h

– hideMeetLink

Return YES if the 3rd party need hide meet link in meet. The default value is NO.

- (BOOL)hideMeetLink

Declared In

MXClient.h

– meetViewControllerDidCreate:

Called when 3rd party want to show the meet view controller by himself when the meet is starting.

- (void)meetViewControllerDidCreate:(UIViewController *)meetViewController

Declared In

MXClient.h

– requestDismissMeetViewController:withCompletion:

Called when we request to let 3rd party dismiss the meet view controller when the meet is ending, you have to call our completion in your meet view controller dismiss completion block.

- (void)requestDismissMeetViewController:(UIViewController *)meetViewController withCompletion:(void ( ^ ) ( ))completion

Declared In

MXClient.h

– shouldShowRingCall

Return NO if the 3rd party need hide ring call when meet call is coming. The default values is YES.

- (BOOL)shouldShowRingCall

Declared In

MXClient.h

– hideInviteButton

Return YES if the 3rd party need hide invite button in meet. The default values is NO.

- (BOOL)hideInviteButton

Declared In

MXClient.h

– supportInviteContactsBySMS

Called when the user invite attendees via pressing invite button in meet. The default values are both YES.

- (BOOL)supportInviteContactsBySMS

Declared In

MXClient.h

– supportInviteContactsByEmail

Called when the user invite attendees via pressing invite button in meet. The default values are both YES.

- (BOOL)supportInviteContactsByEmail

Declared In

MXClient.h

– bodyOfSMSContentWithMeetLink:

Called when the user invite attendees via pressing invite button in meet. Return the customized SMS body. There will be default SMS body if return value is null.

- (nullable NSString *)bodyOfSMSContentWithMeetLink:(NSString *_Nullable)meetLink

Declared In

MXClient.h

– subjectOfEmailContent

Called when the user invite attendees via pressing invite button in meet. Return the customized Email subject. There will be default Email subject if return value is null.

- (nullable NSString *)subjectOfEmailContent

Declared In

MXClient.h

– HTMLBodyOfEmailContentWithMeetLink:

Called when the user invite attendees via pressing invite button in meet. Return the customized Email HTML body. There will be default Email HTML body if return value is null.

- (nullable NSString *)HTMLBodyOfEmailContentWithMeetLink:(NSString *_Nullable)meetLink

Declared In

MXClient.h

– onChatRemoteNotification:

Called when there is a update event on chat from remote notifications.

- (void)onChatRemoteNotification:(NSString *_Nullable)binderID

Declared In

MXClient.h