Show:

Users.Contact Class

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

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

Constructor

Users.Contact

(
  • fields
)

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

Parameters:

Item Index

Methods

Methods

add

(
  • userId
  • label
  • contactUserId
  • callback
)

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

Adds a contact.

Parameters:

  • userId String

    The user's id

  • label String

    The contact's label

  • contactUserId String

    The contact user's id

  • 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
  • contactUserId
  • callback
)

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

Contacts batch getter.

Parameters:

  • userId String

    The user's id

  • label String

    The contact's label

  • contactUserId String

    The contact user's id

  • 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

remove

(
  • userId
  • label
  • contactUserId
  • callback
)

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

Remove a contact.

Parameters:

  • userId String

    The user's id

  • label String

    The contact's label

  • contactUserId String

    The contact user's id

  • 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