API Docs for version 1.2.7300

User

Module: Circuit

Summary

Data object defining a user.

Methods

hasPermission

Syntax

hasPermission

(
  • permission
)
Boolean

Summary

Check if logged on user has a permission. Only applicable to logged on user.

Parameters:

Returns:

Boolean:

true if user has permission

Example:

var isAllowed = user.hasPermission(Circuit.Enums.SystemPermission.MANAGE_TENANT);

Properties

apiVersion

Syntax

apiVersion

String

Summary

API version. Only applicable to logged on user.

avatar

Syntax

avatar

String

Summary

Fully qualified avatar URL for user's small profile picture (40x40px). Default avatar URL if user did not upload a profile picture.

avatarLarge

Syntax

avatarLarge

String

Summary

Fully qualified avatar URL for user's large profile picture (250x250px). Default avatar URL if user did not upload a profile picture.

clientId

Syntax

clientId

String

Summary

Unique identifier for this client connection. Only applicable to logged on user.

company

Syntax

company

String

Summary

Company

displayName

Syntax

displayName

String

Summary

Display name

emailAddress

Syntax

emailAddress

String

Summary

Main Circuit email address

emailAddresses

Syntax

emailAddresses

EmailAddress[]

Summary

Additional email addresses

firstName

Syntax

firstName

String

Summary

First name

hasAvatar

Syntax

hasAvatar

Boolean

Summary

True if user has uploaded an avatar

isExternallyManaged

Syntax

isExternallyManaged

Boolean

Summary

True if user is externaly managed

jobTitle

Syntax

jobTitle

String

Summary

Job title

lastName

Syntax

lastName

String

Summary

Last name

locale

Syntax

locale

String

Summary

User's locale. E.g. EN_US.

phoneNumbers

Syntax

phoneNumbers

PhoneNumber[]

Summary

Phone numbers

tenantId

Syntax

tenantId

String

Summary

Tenant ID

userId

Syntax

userId

String

Summary

User ID

userPresenceState

Syntax

userPresenceState

Presence

Summary

Presence object (state, location, etc). Only applicable for local user. Use getPresence for other users.

userState

Syntax

userState

UserState

Summary

User's state (e.g. ACTIVE, SUSPENDED)

userType

Syntax

userType

UserType

Summary

Type of user (e.g. GUEST, REGULAR)