|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ChannelType
Nested Class Summary | |
---|---|
static class |
ChannelType.AuthStatus
|
Method Summary | |
---|---|
ChannelType.AuthStatus |
acceptAuthorisationCallback(Channel channel,
java.util.Map callbackHeaders,
java.util.Map callbackParams)
This operation is called after the service provider represented by this channel type has redirected the user back to Alfresco. |
boolean |
canPublish()
Does this channel type support publishing content? |
boolean |
canPublishStatusUpdates()
Does this channel type support status updates? |
boolean |
canUnpublish()
Does this channel type support unpublishing content? That is to say, once content has been published to a channel of this type, can it later be removed from that channel? |
java.lang.String |
getAuthorisationUrl(Channel channel,
java.lang.String callbackUrl)
When creating a new channel of this type, this operation is called to find out where the user should be taken in order to authorise Alfresco to publish content / status updates to that channel. |
org.alfresco.service.namespace.QName |
getChannelNodeType()
Each channel is stored in the repository as a node. |
org.springframework.core.io.Resource |
getIcon(java.lang.String size)
Obtain the resource that represents an icon for this channel type. |
java.lang.String |
getId()
Returns the unique identifier of this channel type |
int |
getMaximumStatusLength()
If this channel type supports status updates then this operation returns the maximum permitted length of those status updates. |
java.lang.String |
getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node)
Returns the URL for a piece of content represented by the supplied node . |
java.util.Set |
getSupportedContentTypes()
Returns the set of content types supported by channels of this type. |
java.util.Set |
getSupportedMimeTypes()
Returns the set of MIME types supported by channels of this type. |
void |
sendStatusUpdate(Channel channel,
java.lang.String status)
Send the specified status update to the specified channel |
Method Detail |
---|
java.lang.String getId()
org.alfresco.service.namespace.QName getChannelNodeType()
boolean canPublish()
boolean canUnpublish()
boolean canPublishStatusUpdates()
void sendStatusUpdate(Channel channel, java.lang.String status)
channel
- status
- java.util.Set getSupportedMimeTypes()
java.util.Set getSupportedContentTypes()
java.lang.String getNodeUrl(org.alfresco.service.cmr.repository.NodeRef node)
node
.
node
- The published content node in the live environment.
int getMaximumStatusLength()
java.lang.String getAuthorisationUrl(Channel channel, java.lang.String callbackUrl)
channel
- The channel that needs to be authorised.callbackUrl
- Where the service provider represented by this channel type should redirect the user to once
the authorisation procedure is complete.
ChannelType.AuthStatus acceptAuthorisationCallback(Channel channel, java.util.Map callbackHeaders, java.util.Map callbackParams)
channel
- The channel related to this authorisation callback.callbackHeaders
- All the HTTP headers received in the callback.callbackParams
- All the HTTP parameters received in the callback.
org.springframework.core.io.Resource getIcon(java.lang.String size)
size
- A text representation of the icon size required. "16", "32", etc.
null
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |