Class Index | File Index

Classes


Class Alfresco.ConsoleChannels

Extends Alfresco.ConsoleTool
ConsoleChannels tool component.
Defined in: channel-admin.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
ConsoleChannels constructor.
Field Summary
Field Attributes Field Name and Description
 
Handle to the window created during channel auth.
 
Contains details for instantiating Insitu editors
 
Is the UI waiting for a callback from the Auth Scripts?
Fields borrowed from class Alfresco.ConsoleTool:
currentPanelId, panels, popups
Fields borrowed from class Alfresco.component.Base:
modules, options, services, widgets
Method Summary
Method Attributes Method Name and Description
 
authoriseChannel(authUrl, reauth)
Kicks off the authentication process and enables the listener.
 
newChannelName(channelType)
Generates a new, unique, name for the channel
 
onAuthCallback(hash, url)
Triggers a call to the authorise Callback URL, submitting the received token.
 
Called when a channel has been created and authentication has finished (regardless to outcome)
 
Called when one of the channel actions is triggered.
 
onChannelRename(o, args)
Triggered after the channel has been renamed
 
onCreateChannel(event, args)
Called when the new channel button is clicked
 
Called when the channel create API call returns successfully, this triggers the start of the authentication process.
 
onDeleteChannel(event, args)
Triggers an API call to delete the channel.
 
Called when the Ajax call to the Delete API succeeds.
 
onEditNode(event, o)
Loads the form to edit a channel node
 
Editing the node has finished, reload the channels.
 
onPermissionsClick(event, args)
Triggered when someone clicks on the permissions link
 
Called on successful load of the permissions management HTML.
 
Fired by YUI when parent element is available for scripting.
 
onReauthChannel(event, args)
Called by the reauth channelAction
 
onReauthSuccess(response)
Called when the Reauthorise API call succeeds
 
onRenderEvent(o, args)
Triggered after the data table has been rendered
 
Overrides the onStateChanged to listen for token response
 
Refreshes the channels
 
renderCellChannel(elCell, oRecord, oColumn, oData)
Called by the Alfresco.util.dataTable method to render each channel into the dom.
 
renderChannel(channel)
Builds the HTML for existing channels
 
Set multiple initialization options at once.
Methods borrowed from class Alfresco.ConsoleTool:
onHistoryManagerReady
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, setMessages
Constructor Detail
Alfresco.ConsoleChannels(htmlId)
ConsoleChannels constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.ConsoleChannels} The new ConsoleChannels instance
Field Detail
authWindow
Handle to the window created during channel auth.

{array} insituEditors
Contains details for instantiating Insitu editors
(array generated during cell rendering, editors instantiated after DOM written.)

isWaiting
Is the UI waiting for a callback from the Auth Scripts?
Method Detail
authoriseChannel(authUrl, reauth)
Kicks off the authentication process and enables the listener.

Supported scenarios:
window.postMessage is supported by browser, so we can communicate with iframe.
window.postMessage is NOT supported by browser, so we ignore iframe.
However: the redirect URL must be the same, host protocol and port as the page that triggers the redirect.
Parameters:
{Object} authUrl
reauth

newChannelName(channelType)
Generates a new, unique, name for the channel
Parameters:
channelType

onAuthCallback(hash, url)
Triggers a call to the authorise Callback URL, submitting the received token.
Parameters:
{string} hash
{string} url

onAuthComplete()
Called when a channel has been created and authentication has finished (regardless to outcome)

onChannelInteraction(o, args)
Called when one of the channel actions is triggered.
Parameters:
{Object} o
{Object} args

onChannelRename(o, args)
Triggered after the channel has been renamed
Parameters:
{Object} o
{Object} args

onCreateChannel(event, args)
Called when the new channel button is clicked
Parameters:
event
args

onCreateChannelSuccess(response)
Called when the channel create API call returns successfully, this triggers the start of the authentication process.
Parameters:
{Object} response

onDeleteChannel(event, args)
Triggers an API call to delete the channel.
Parameters:
event
args

onDeleteChannelSuccess(response)
Called when the Ajax call to the Delete API succeeds.
Parameters:
{Object} response

onEditNode(event, o)
Loads the form to edit a channel node
Parameters:
event
o

onEditNodeFinished()
Editing the node has finished, reload the channels.

onPermissionsClick(event, args)
Triggered when someone clicks on the permissions link
The fires up the manage permissions webscript and supplies the callback that initialises it.
Parameters:
{Object} event
{Object} args

onPermissionsTemplateLoaded(response)
Called on successful load of the permissions management HTML.
Parameters:
{Object} response

onReady()
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onReauthChannel(event, args)
Called by the reauth channelAction
Parameters:
{Object} event
{Object} args

onReauthSuccess(response)
Called when the Reauthorise API call succeeds

Triggers the restart of the Authorisation process
Parameters:
response

onRenderEvent(o, args)
Triggered after the data table has been rendered
Parameters:
{Object} o
{Object} args

onStateChanged()
Overrides the onStateChanged to listen for token response

refresh()
Refreshes the channels

renderCellChannel(elCell, oRecord, oColumn, oData)
Called by the Alfresco.util.dataTable method to render each channel into the dom.
Parameters:
elCell
oRecord
oColumn
oData

renderChannel(channel)
Builds the HTML for existing channels
Parameters:
{Object} channel

setOptions(obj)
Set multiple initialization options at once.
Parameters:
{object} obj
Object literal specifying a set of options

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:24 GMT-0000 (GMT)