com.netease.nimlib.sdk.avsignalling

Interface SignallingServiceObserver

public interface SignallingServiceObserver

Method Summary

Modifier and Type	Method and Description
void	observeMemberUpdateNotification(Observer<MemberUpdateEvent> observer, boolean register) Register or unregister the observer for update events of channel members
void	observeOfflineNotification(Observer<java.util.ArrayList<ChannelCommonEvent>> observer, boolean register) Register or unregister the observer for offline notification event.
void	observeOnlineNotification(Observer<ChannelCommonEvent> observer, boolean register) Register or unregister the observer for online notification events The subtypes of RoomCommonEvent are returned.
void	observeOtherClientInviteAckNotification(Observer<InviteAckEvent> observer, boolean register) Register or unregister the observer for responses to the invite request on other devices.
void	observeSyncChannelListNotification(Observer<java.util.ArrayList<SyncChannelListEvent>> observer, boolean register) Register or unregister the observer for list of remaining channels.

Method Detail

observeOnlineNotification

void observeOnlineNotification(Observer<ChannelCommonEvent> observer,
                               boolean register)

Register or unregister the observer for online notification events The subtypes of RoomCommonEvent are returned. If users want to get the special properties in the corresponding subtypes, convert types based on ChannelCommonEvent.getEventType()

Event type SignallingEventType and ChannelCommonEvent subtypes are associated in the following way:
SignallingEventType.CLOSE is related to ChannelCloseEvent
SignallingEventType.JOIN is related to UserJoinEvent
SignallingEventType.INVITE is related to InvitedEvent
SignallingEventType.CANCEL_INVITE is related to CanceledInviteEvent
SignallingEventType.REJECT is related to InviteAckEvent
SignallingEventType.ACCEPT is related to InviteAckEvent
SignallingEventType.LEAVE is related to UserLeaveEvent
SignallingEventType.CONTROL is related to ControlEvent

Parameters:

observer - observer. The parameter is the online notification event

register - true: register the observer; false: unregister the observer

observeOfflineNotification

void observeOfflineNotification(Observer<java.util.ArrayList<ChannelCommonEvent>> observer,
                                boolean register)

Register or unregister the observer for offline notification event. When users log in, the SDK will sync the notifications during offline and return the notifications in array. The notifications are displayed in ascending order ChannelCommonEvent.getTime()

Note: if the observer is registered for the first time after a user logs in and the SDK already gets the offline notifications, the callback is triggered immediately

The subtypes of ChannelCommonEvent are returned. If users want to get the special properties in the corresponding subtypes, convert types based on ChannelCommonEvent.getEventType()

Event type SignallingEventType and ChannelCommonEvent subtypes are associated in the following way:
SignallingEventType.CLOSE is related to ChannelCloseEvent
SignallingEventType.JOIN is related to UserJoinEvent
SignallingEventType.INVITE is related to InvitedEvent
SignallingEventType.CANCEL_INVITE is related to CanceledInviteEvent
SignallingEventType.REJECT is related to InviteAckEvent
SignallingEventType.ACCEPT is related to InviteAckEvent
SignallingEventType.LEAVE is related to UserLeaveEvent

Parameters:

observer - observer. The parameter is the offline notifications

register - true: register the observer; false: unregister the observer

observeOtherClientInviteAckNotification

void observeOtherClientInviteAckNotification(Observer<InviteAckEvent> observer,
                                             boolean register)

Register or unregister the observer for responses to the invite request on other devices. The callback is triggered when other devices respond to the invitation.

Parameters:

observer - observer. The callback parameter is response from other clients

register - true: register the observer; false: unregister the observer

observeSyncChannelListNotification

void observeSyncChannelListNotification(Observer<java.util.ArrayList<SyncChannelListEvent>> observer,
                                        boolean register)

Register or unregister the observer for list of remaining channels. After a user logs in, the SDK gets the list of channels the user does not leave.

Note: if the observer is registered for the first time after a user logs in and the SDK already gets the list of channels, the callback is triggered immediately

Parameters:

observer - The observer. The callback parameter is the list of channels the user does not leave.

register - true: register the observer; false: unregister the observer

observeMemberUpdateNotification

void observeMemberUpdateNotification(Observer<MemberUpdateEvent> observer,
                                     boolean register)

Register or unregister the observer for update events of channel members

Parameters:

observer - observer. The callback parameter is the member update event, which contains the complete information of the latest channel (channel and member list)

Note: If a member leaves or joins the channel, in most cases, the user will be notified by observeOnlineNotification(com.netease.nimlib.sdk.Observer<com.netease.nimlib.sdk.avsignalling.event.ChannelCommonEvent>, boolean).
In this case, the callback is triggered if: a member profile changes (not leaving or joining a channel) or exceptions occur but observeOnlineNotification(com.netease.nimlib.sdk.Observer<com.netease.nimlib.sdk.avsignalling.event.ChannelCommonEvent>, boolean) is not triggered

register - true: register the observer; false: unregister the observer