microsoft.hawaii.sdk.relayService

Class RelayService

java.lang.Object

microsoft.hawaii.sdk.relayService.RelayService

public class RelayService
extends java.lang.Object

Helper class that provides access to the Relay service.

Constructor Summary

Constructors

Constructor and Description
RelayService()

Method Summary

Methods

Modifier and Type	Method and Description
static void	createEndPoint(ClientIdentity identity, java.lang.String name, OnCompleteListener<EndpointResult> completedCallback, java.lang.Object state) Helper method to initiate the call that creates an endpoint.
static void	createGroup(ClientIdentity identity, int timeoutInSeconds, OnCompleteListener<GroupResult> completedCallback, java.lang.Object state) Helper method to initiate the call that creates a new group.
static void	deleteEndPoint(ClientIdentity identity, java.lang.String registrationId, java.lang.String secretKey, OnCompleteListener<EndpointResult> completedCallback, java.lang.Object state) Helper method to initiate the call that deletes an endpoint.
static void	deleteGroup(ClientIdentity identity, java.lang.String registrationId, java.lang.String secretKey, OnCompleteListener<GroupResult> completedCallback, java.lang.Object state) Helper method to initiate the call that deletes a group.
static void	joinGroup(ClientIdentity identity, java.lang.String groupRegistrationId, java.lang.String endpointRegistrationId, java.lang.String secretKey, OnCompleteListener<GroupResult> completedCallback, java.lang.Object state) Helper method to initiate the call that will join an endpoint to a group.
static void	leaveGroup(ClientIdentity identity, java.lang.String groupRegistrationId, java.lang.String endpointRegistrationId, java.lang.String secretKey, OnCompleteListener<GroupResult> completedCallback, java.lang.Object state) Helper method to initiate the call that will have an endpoint leave from a group.
static void	receiveMessage(ClientIdentity identity, java.lang.String registrationId, java.lang.String secretKey, java.lang.String filter, OnCompleteListener<MessageResult> completedCallback, java.lang.Object state) Helper method to initiate the call that will receive a message.
static void	sendMessage(ClientIdentity identity, byte[] message, java.lang.String fromRegistrationId, java.lang.String recipientIds, java.lang.String secretKey, OnCompleteListener<MessageResult> completedCallback, java.lang.Object state) Helper method to initiate the call that will send a message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelayService

public RelayService()

Method Detail

createEndPoint

public static void createEndPoint(ClientIdentity identity,
                  java.lang.String name,
                  OnCompleteListener<EndpointResult> completedCallback,
                  java.lang.Object state)
                           throws java.lang.Exception

Helper method to initiate the call that creates an endpoint.

Parameters:

identity - the client identity

name - Specifies a name of the endpoint

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

createGroup

public static void createGroup(ClientIdentity identity,
               int timeoutInSeconds,
               OnCompleteListener<GroupResult> completedCallback,
               java.lang.Object state)
                        throws java.lang.Exception

Helper method to initiate the call that creates a new group.

Parameters:

identity - client identity

timeoutInSeconds - Specifies the time to live in the service

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

deleteEndPoint

public static void deleteEndPoint(ClientIdentity identity,
                  java.lang.String registrationId,
                  java.lang.String secretKey,
                  OnCompleteListener<EndpointResult> completedCallback,
                  java.lang.Object state)
                           throws java.lang.Exception

Helper method to initiate the call that deletes an endpoint.

Parameters:

identity - client identity

registrationId - the endpoint registrationId

secretKey - the endpoint secretKey

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

deleteGroup

public static void deleteGroup(ClientIdentity identity,
               java.lang.String registrationId,
               java.lang.String secretKey,
               OnCompleteListener<GroupResult> completedCallback,
               java.lang.Object state)
                        throws java.lang.Exception

Helper method to initiate the call that deletes a group.

Parameters:

identity - client identity

registrationId - the group registrationId

secretKey - the group secretKey

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

joinGroup

public static void joinGroup(ClientIdentity identity,
             java.lang.String groupRegistrationId,
             java.lang.String endpointRegistrationId,
             java.lang.String secretKey,
             OnCompleteListener<GroupResult> completedCallback,
             java.lang.Object state)
                      throws java.lang.Exception

Helper method to initiate the call that will join an endpoint to a group.

Parameters:

identity - the client identity

groupRegistrationId - the group registrationId

endpointRegistrationId - the endpoint registrationId

secretKey - the endpoint secretKey

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

leaveGroup

public static void leaveGroup(ClientIdentity identity,
              java.lang.String groupRegistrationId,
              java.lang.String endpointRegistrationId,
              java.lang.String secretKey,
              OnCompleteListener<GroupResult> completedCallback,
              java.lang.Object state)
                       throws java.lang.Exception

Helper method to initiate the call that will have an endpoint leave from a group.

Parameters:

identity - the client identity

groupRegistrationId - the group registrationId

endpointRegistrationId - the endpoint registrationId

secretKey - the endpoint secretKey

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

receiveMessage

public static void receiveMessage(ClientIdentity identity,
                  java.lang.String registrationId,
                  java.lang.String secretKey,
                  java.lang.String filter,
                  OnCompleteListener<MessageResult> completedCallback,
                  java.lang.Object state)
                           throws java.lang.Exception

Helper method to initiate the call that will receive a message.

Parameters:

identity - client identity

registrationId - the endpoint registrationId

secretKey - the endpoint secretKey

filter - Specifies a list of registration ids for Endpoints and/or Groups that identify senders and/or group recipients of desired messages.

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception

sendMessage

public static void sendMessage(ClientIdentity identity,
               byte[] message,
               java.lang.String fromRegistrationId,
               java.lang.String recipientIds,
               java.lang.String secretKey,
               OnCompleteListener<MessageResult> completedCallback,
               java.lang.Object state)
                        throws java.lang.Exception

Helper method to initiate the call that will send a message.

Parameters:

identity - client identity

message - the message content

fromRegistrationId - the endpoint registrationId

recipientIds - the recipients ids

secretKey - the endpoint secretKey

completedCallback - completion callback

state - user defined state object

Throws:

java.lang.Exception