com.netease.nimlib.sdk.event

Interface EventSubscribeService

public interface EventSubscribeService

Event subscription service

Method Summary

Modifier and Type	Method and Description
InvocationFuture<java.lang.Void>	batchUnSubscribeEvent(EventSubscribeRequest request) Unsubscribe to all specific events.
InvocationFuture<Event>	publishEvent(Event event) Publish event
InvocationFuture<java.util.List<EventSubscribeResult>>	querySubscribeEvent(EventSubscribeRequest request) Query the subscription relationship to specific events.
InvocationFuture<java.util.List<java.lang.String>>	subscribeEvent(EventSubscribeRequest request) Subscribe event
InvocationFuture<java.util.List<java.lang.String>>	unSubscribeEvent(EventSubscribeRequest request) Unsubscribe to specific event based on accounts.

Method Detail

publishEvent

InvocationFuture<Event> publishEvent(Event event)

Publish event

Parameters:

event - The event

Returns:

InvocationFuture can set a callback function. After the request is completed, the method can be called. If an error occurs, a specific error code will be returned.

subscribeEvent

InvocationFuture<java.util.List<java.lang.String>> subscribeEvent(EventSubscribeRequest request)

Subscribe event

Parameters:

request - To subscribe to request info, the event type, publisher account, and the expiration duration must be specified.

Returns:

InvocationFuture can set a callback function. The method can be called after the request is completed. The array of accounts that fail to subscribe to events is returned. If the length of the array is 0, all accounts have subscribed successfully. If an error occurs, a specific error code will be returned.

unSubscribeEvent

InvocationFuture<java.util.List<java.lang.String>> unSubscribeEvent(EventSubscribeRequest request)

Unsubscribe to specific event based on accounts.

Parameters:

request - The unsubscription info. Only event type and evetn publisher accounts are required.

Returns:

InvocationFuture can set a callback function. The method can be called after the request is completed. The array of accounts that fail to unsubscribe from events is returned. If the length of the array is 0, all accounts have subscribed successfully. If an error occurs, a specific error code will be returned.

batchUnSubscribeEvent

InvocationFuture<java.lang.Void> batchUnSubscribeEvent(EventSubscribeRequest request)

Unsubscribe to all specific events.

Parameters:

request - The unsubscription info. Only event type is required.

Returns:

InvocationFuture can set a callback function. After the request is completed, the method can be called. If an error occurs, a specific error code will be returned.

querySubscribeEvent

InvocationFuture<java.util.List<EventSubscribeResult>> querySubscribeEvent(EventSubscribeRequest request)

Query the subscription relationship to specific events.

Parameters:

request - The subscriotion info. The event type and publisher accounts are required. The publisher for specific events can be queried.

Returns:

InvocationFuture can set a callback function. After the request is completed, the method can be called. If an error occurs, a specific error code will be returned.