Show:

Users.Label Class

Defined in: platform/plugins/Users/web/js/Users.js:2086
Module: Users

Constructs a label from fields, which are typically returned from the server.

Constructor

Users.Label

(
  • fields
)

Defined in platform/plugins/Users/web/js/Users.js:2086

Parameters:

Item Index

Methods

Methods

add

(
  • userId
  • title
  • callback
)

Defined in platform/plugins/Users/web/js/Users.js:2128

Adds a label.

Parameters:

  • userId String

    The user's id

  • title String

    The contact label's title

  • callback Function

    if there were errors, first parameter is an array of errors otherwise, first parameter is null and second parameter is a Users.Contact object

get

(
  • userId
  • label
  • callback
)

Defined in platform/plugins/Users/web/js/Users.js:2098

Labels batch getter.

Parameters:

  • userId String

    The user's id

  • label String

    The label's internal name

  • callback Function

    if there were errors, first parameter is an array of errors otherwise, first parameter is null and second parameter is a Users.Label object

remove

(
  • userId
  • label
  • callback
)

Defined in platform/plugins/Users/web/js/Users.js:2144

Remove a label.

Parameters:

  • userId String

    The user's id

  • label String

    The contact label's label

  • callback Function

    if there were errors, first parameter is an array of errors otherwise, first parameter is null and second parameter is a Users.Contact object

(
  • [size=40]
)
String

Defined in platform/plugins/Users/web/js/Users.js:2160

Calculate the url of a label's icon

Parameters:

  • [size=40] Number optional

    the size of the icon to render.

Returns:

String:

the url