Module: alfresco/header/CurrentUserStatus

alfresco/header/CurrentUserStatus

Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

cancelUserStatusUpdateTopic :string

This is the topic used to subscribe to requests to cancel logging preferences updates set in the preferences dialog.
Type:
  • string
Default Value:
  • "ALF_CANCEL_USER_STATUS_UPDATE"
Source:

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/CurrentUserStatus"}]
Source:

i18nRequirements :object[]

An array of the i18n files to use with this widget.
Type:
  • object[]
Default Value:
  • [{i18nFile: "./i18n/CurrentUserStatus"}]
Source:

postNewUserStatusTopic :string

This is the topic used to subscribe to requests to save logging preferences updated by the preferences dialog.
Type:
  • string
Default Value:
  • "ALF_POST_NEW_USER_STATUS"
Source:

statusDialog :object

This attribute is used to hold a reference to a dialog that can be used to set the user status. It is created on the first call to the showStatusDialog function.
Type:
  • object
Default Value:
  • null
Source:

templateString :string

The HTML template to use for the widget.
Type:
  • string
Source:

unknownStatus :boolean

This indicates whether or not the current user status is known. It is initialised to null but will be set with a boolean value during the postCreate function to indicate whether or not a status was passed as an argument. This could be useful when making a decision on how the status is displayed.
Type:
  • boolean
Source:

userStatus :string

This represents the current user status. It should be provided with a value when the widget is instantiated.
Type:
  • string
Source:

userStatusTime :string

This represents the time of the last user status update. It should be provided with a value when the widget is instantiated.
Type:
  • string
Source:

Methods

postCreate()

Source:

postStatus(payload)

Called when the user clicks on the post button from the dialog
Parameters:
Name Type Description
payload object The click event
Source:

setStatusRelativeTime()

This function was originally copied from header.js. PLEASE NOTE: That it still uses the Alfresco.util.relativeTime function which will be available in Share for the considerable future but at some point this function will need to be ported to the Dojo framework.
Source:

showStatusDialog(payload)

Parameters:
Name Type Description
payload object
Source:

statusUpdated(payload)

This is the handler called when "ALF_USER_STATUS_UPDATED" topics are published. It retrieves the new status (if available) and status update time (if available) and displays them in the widget.
Parameters:
Name Type Description
payload object
Source: