com.mongodb.stitch.android.services.fcm

Interface FcmServiceClient

All Known Implementing Classes:

FcmServiceClientImpl

public interface FcmServiceClient

The FCM service client.

Field Summary

Fields

Modifier and Type	Field and Description
static NamedServiceClientFactory<FcmServiceClient>	factory

Method Summary

Modifier and Type	Method and Description
Task<FcmSendMessageResult>	sendMessageTo(String to, FcmSendMessageRequest request) Sends an FCM message to the given target with the given request payload.
Task<FcmSendMessageResult>	sendMessageToRegistrationTokens(Collection<String> registrationTokens, FcmSendMessageRequest request) Sends an FCM message to the given set of registration tokens with the given request payload.
Task<FcmSendMessageResult>	sendMessageToUsers(Collection<String> userIds, FcmSendMessageRequest request) Sends an FCM message to the given set of Stitch users with the given request payload.

Field Detail

factory

static final NamedServiceClientFactory<FcmServiceClient> factory

Method Detail

sendMessageTo

Task<FcmSendMessageResult> sendMessageTo(String to,
                                         FcmSendMessageRequest request)

Sends an FCM message to the given target with the given request payload.

Parameters:

to - the target to send a message to.

request - the details of the message.

Returns:

A Task that contains the result of sending the message.

sendMessageToUsers

Task<FcmSendMessageResult> sendMessageToUsers(Collection<String> userIds,
                                              FcmSendMessageRequest request)

Sends an FCM message to the given set of Stitch users with the given request payload.

Parameters:

userIds - the Stitch users to send a message to.

request - the details of the message.

Returns:

A Task that contains the result of sending the message.

sendMessageToRegistrationTokens

Task<FcmSendMessageResult> sendMessageToRegistrationTokens(Collection<String> registrationTokens,
                                                           FcmSendMessageRequest request)

Sends an FCM message to the given set of registration tokens with the given request payload.

Parameters:

registrationTokens - the devices to send a message to.

request - the details of the message.

Returns:

A Task that contains the result of sending the message.