org.jboss.aerogear.simplepush.protocol

Interface RegisterResponse

All Superinterfaces:

MessageType, RegisterMessage

All Known Implementing Classes:

RegisterResponseImpl

public interface RegisterResponse
extends RegisterMessage

Represents the Register response message, 'register' message type, in the SimplePush specification protocol

This message is sent from the PushServer to the UserAgent with the result of a registration request.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MessageType.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUSH_ENDPOINT__FIELD The name of the pushEndpoint JSON field.
static String	STATUS_FIELD The name of the status JSON field.

Fields inherited from interface org.jboss.aerogear.simplepush.protocol.RegisterMessage

CHANNEL_ID_FIELD

Fields inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MESSSAGE_TYPE_FIELD

Method Summary

Methods

Modifier and Type	Method and Description
String	getPushEndpoint() Returns the push endpoint for this channel.
Status	getStatus() Returns the result of the Register call

Methods inherited from interface org.jboss.aerogear.simplepush.protocol.RegisterMessage

getChannelId

Methods inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

getMessageType

Field Detail

STATUS_FIELD

static final String STATUS_FIELD

The name of the status JSON field.

See Also:

Constant Field Values

PUSH_ENDPOINT__FIELD

static final String PUSH_ENDPOINT__FIELD

The name of the pushEndpoint JSON field.

See Also:

Constant Field Values

Method Detail

getStatus

Status getStatus()

Returns the result of the Register call

Returns:

String the channelId.

getPushEndpoint

String getPushEndpoint()

Returns the push endpoint for this channel. This is the endpoint URL that is passed back to the UserAgent upon registering a channel. The UserAgent will then update the server side application of this endpoint, which the server side application will then use when it wants to trigger a notification.

Returns:

String the endpoint which can be used to trigger notifications.