|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Channel
Represents a publishing channel
Method Summary | |
---|---|
boolean |
canPublish()
Returns true only if the currently authenticated user can publish content to this Channel . |
boolean |
canPublishStatusUpdates()
Returns true only if the currently authenticated user can unpublish status updates to this Channel . |
boolean |
canUnpublish()
Returns true only if the currently authenticated user can unpublish content from this Channel . |
ChannelType |
getChannelType()
|
java.lang.String |
getId()
|
java.lang.String |
getName()
Retrieve the name of this channel |
org.alfresco.service.cmr.repository.NodeRef |
getNodeRef()
Retrieve the node ref of the node that represents this channel object in the repository |
java.util.Map |
getProperties()
Retrieve the properties defined on this channel. |
java.lang.String |
getUrl(org.alfresco.service.cmr.repository.NodeRef publishedNode)
Returns the URL for the specified node on this channel. |
boolean |
isAuthorised()
Has this channel been authorised yet? Typically, when a channel is created in Alfresco the user is sent to the service provider to authorise Alfresco to access their account on their behalf. |
void |
sendStatusUpdate(java.lang.String status,
java.lang.String urlToAppend)
Post the specified text onto this channel as a status update. |
Method Detail |
---|
java.lang.String getId()
Channel
.ChannelType getChannelType()
ChannelType
for this Channel.org.alfresco.service.cmr.repository.NodeRef getNodeRef()
java.lang.String getName()
java.util.Map getProperties()
void sendStatusUpdate(java.lang.String status, java.lang.String urlToAppend)
status
- The text of the status update. Note that if the length of this text plus the
length of the urlToAppend text is greater than the maximum length permitted as a status
update on this channel then this text will be truncated to fit.urlToAppend
- Text that is to be appended to the status update - often a URL to a relevant
piece of content. If this channel can't accept both the status text and the URL then the status text
will be truncated in preference to the URL. This argument may be null.java.lang.String getUrl(org.alfresco.service.cmr.repository.NodeRef publishedNode)
The
- content node whose published URL is being requested.
null
if the specified node has not
been published to this channel.boolean isAuthorised()
boolean canPublish()
true
only if the currently authenticated user can publish content to this Channel
.
If the ChannelType
does not support publishing, if the Channel
is not authorised or if the
currently authenticated user does not have permission to publish to this Channel
then this
method will return false
.
boolean canUnpublish()
true
only if the currently authenticated user can unpublish content from this Channel
.
If the ChannelType
does not support unpublishing, if the Channel
is not authorised or if the
currently authenticated user does not have permission to publish to this Channel
then this method
will return false
.
boolean canPublishStatusUpdates()
true
only if the currently authenticated user can unpublish status updates to this Channel
.
If the ChannelType
does not support publishing of status updates, if the Channel
is not authorised
or if the currently authenticated user does not have permission to publish to this Channel
then this method
will return false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |