org.jboss.aerogear.simplepush.protocol
Interface RegisterMessage

All Superinterfaces:

MessageType

All Known Subinterfaces:

RegisterResponse

All Known Implementing Classes:

RegisterMessageImpl, RegisterResponseImpl

public interface RegisterMessage
extends MessageType

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

This message is sent from the UserAgent to the PushServer to register for notifications using the channelId. The channelId is create by the UserAgent.

Nested Class Summary

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

MessageType.Type

Field Summary

static String

CHANNEL_ID_FIELD The name of the channelID JSON field.

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

MESSSAGE_TYPE_FIELD

Method Summary

String

getChannelId() Returns the channelId that was sent from the UserAgent.

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

getMessageType

Field Detail

CHANNEL_ID_FIELD

static final String CHANNEL_ID_FIELD

The name of the channelID JSON field.

See Also:

Constant Field Values

Method Detail

getChannelId

String getChannelId()

Returns the channelId that was sent from the UserAgent.

Returns:

String the channelId.