UserUpdate

UserUpdate

# new UserUpdate(userMap)

Creates a new UserUpdate instance from the provider parameters.
Parameters:
Name Type Description
userMap Object User update parameters
Properties
Name Type Attributes Default Description
displayName string <optional>
 User Display name
avatarFile File <optional>
 User Avatar File
avatarUrl string <optional>
 User Avatar URL
publicProperties Object.<string, string> <optional>
 {} User public properties
privateProperties Object.<string, string> <optional>
 {} User private properties
Source:

Methods

# decrementPrivateProperty(key, decrement)

Decrement a private property with the provided value.
Parameters:
Name Type Description
key string Property key
decrement number Positive number
Source:
Returns:
same instance.

# decrementPublicProperty(key, decrement)

Decrement a public property with the provided value.
Parameters:
Name Type Description
key string Property key
decrement number Positive number
Source:
Returns:
same instance.

# incrementPrivateProperty(key, increment)

Increment a private property with the provided value.
Parameters:
Name Type Description
key string Property key
increment number Positive number
Source:
Returns:
same instance.

# incrementPublicProperty(key, increment)

Increment a public property with the provided value.
Parameters:
Name Type Description
key string Property key
increment number Positive number
Source:
Returns:
same instance.

# removePrivateProperty(key)

Remove private property with the given key.
Parameters:
Name Type Description
key string Property key
Source:
Returns:
same instance.

# removePublicProperty(key)

Remove public property with the given key.
Parameters:
Name Type Description
key string Property key
Source:
Returns:
same instance.

# setPrivateProperty(key, value)

Set a private property with the provided key-value pair.
Parameters:
Name Type Description
key string Property key
value string Property value
Source:
Returns:
same instance.

# setPublicProperty(key, value)

Set a public property with the provided key-value pair.
Parameters:
Name Type Description
key string Property key
value string Property value
Source:
Returns:
same instance.

# updateAvatarUrl(avatarUrl)

Set the avatar URL.
Parameters:
Name Type Description
avatarUrl string New avatar URL.
Source:
Returns:
same instance.

# updateAvatarWithFile(avatarFile)

Set the avatar with a file. If set, it will overwrite the value for avatarUrl on update
Parameters:
Name Type Description
avatarFile File New avatar.
Source:
Returns:
same instance.

# updateDisplayName(displayName)

Set the display name.
Parameters:
Name Type Description
displayName string New display name.
Source:
Returns:
same instance.