IamUtil.updateUserDisplayNameAsync() Overload 1

DESCRIPTION

Asynchronously update an IAM user’s display name on device.

The specified AsyncIamResultReceiver closure is invoked with IamError.OK upon successful completion or with an error if an error occurs. See the updateUserDisplayName() function for details about possible error codes and known issues.

DECLARATION

static public func updateUserDisplayNameAsync(connection: Connection,
                                                  username: String,
                                                  displayName: String,
                                                  closure: @escaping AsyncIamResultReceiver)

PARAMETERS

connection:

An established connection to the device

username:

Username for the user that should have display name updated

displayName:

New display name

closure:

Invoked when the user is deleted or an error occurs

Overload 2

DESCRIPTION

Asynchronously update an IAM user’s display name on device.

Uses Swift concurrency and is therefore only available on iOS 13 and above.

DECLARATION

static public func updateUserDisplayNameAsync(connection: Connection,
                                                  username: String,
                                                  displayName: String
    ) async throws

PARAMETERS

connection:

An established connection to the device

username:

Username for the user that should have display name updated

displayName:

New display name

THROWS ERRORS

USER_DOES_NOT_EXIST:

if the specified user does not exist on the device.

BLOCKED_BY_DEVICE_CONFIGURATION:

if the device configuration does not allow the current user to update the specified user's display name (the IAM:SetUserDisplayName action is not allowed for the requesting role for the IAM:Username user)

IAM_NOT_SUPPORTED:

if Nabto Edge IAM is not supported by the device