Manage user details

Get details about the app users.

Get user details

Return data about a specific user with the getUser() method.

By default, this method returns all custom user metadata without the need to define that during the call explicitly.

Requires App Context

To store data about users, you must enable App Context for your app's keyset in the Admin Portal.

Method signature

This method takes the following parameters:

chat.getUser(
    userId: String
) async throws -> UserImpl?

Input

* required

Parameter	Description
userId * Type: String Default: n/a	Unique user identifier (up to 92 UTF-8 characters).

Output

Parameter	Description
UserImpl	Returned object containing the user metadata.

Basic usage

Sample code

The code samples in Swift Chat SDK focus on asynchronous code execution.

You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.

Get details on user support_agent_15.

// Assuming you have a reference of type "ChatImpl" named "chat"
Task {
  if let user = try await chat.getUser(userId: "support_agent_15") {
    debugPrint("Fetched user metadata with ID: \(user.id)")
  } else {
    debugPrint("User not found")
  }
}

Get current user

You can access the currentUser property of the Chat object to get the current chat user of the chat app.

Requires App Context

To store data about users, you must enable App Context for your app's keyset in the Admin Portal.

Basic usage

Sample code

The code samples in Swift Chat SDK focus on asynchronous code execution.

You can also write synchronous code as the parameters are shared between the async and sync methods but we don't provide usage examples of such.

Return the current chat user.

/// Assuming you have a reference of type "ChatImpl" named "chat"
/// Access the "currentUser" property to get details of the current chat user
let currentUser = chat.currentUser