# Presence (/en/realtime-media/im/build/build-core-messaging/presence/flutter)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

The presence feature enables users to publicly display their online presence status and quickly determine the status of other users. Users can also customize their presence status, which adds fun and diversity to real-time chatting.

    The following illustration shows the implementation of creating a custom presence status and how various presence statues look in a contact list:

    ![1655302046418](https://web-cdn.agora.io/docs-files/1655302046418)

    ## Understand the tech [#understand-the-tech-2]

    The Chat SDK provides the `ChatPresence`, `ChatPresenceManager`, and `ChatPresenceEventHandler` classes for presence management, which allows you to implement the following features:

    The following figure shows the workflow of how clients subscribe to and publish presence statuses:

    Presence workflow

    ![1655718659347](https://web-cdn.agora.io/docs-files/1655718659347)

    1. User A subscribes to the presence status of User B.
    2. User B publishes a presence status.
    3. The Chat server triggers an event to notify User A about the presence update of User B.

    ## Prerequisites [#prerequisites-2]

    Before proceeding, ensure that your environment meets the following requirements:

    * You have initialized the Chat SDK. For details, see [SDK quickstart](../../get-started-sdk).
    * You understand the API call frequency limit as described in [Limitations](../limitations).
    * You have activated the presence feature in [Agora Console](https://console.agora.io/v2).

    ## Implementation [#implementation-2]

    This section introduces how to implement presence functionalities in your project.

    ### Subscribe to the presence status of one or more users [#subscribe-to-the-presence-status-of-one-or-more-users-2]

    By default, you do not subscribe to any users. To subscribe to the presence statuses of the specified users, you can call `subscribe`. Whenever the specified users update their presence statuses, the `onPresenceStatusChanged` callback is triggered, notifying you about the updated statuses asynchronously.

    The following code sample shows how to subscribe to the presence status of one or more users:

    ```dart
    // members: The ID list of users to whom you subscribe.
    List members = [];
    // expiry: The subscription duration in seconds.
    int expiry = 100;
    try {
      List list =
          await ChatClient.getInstance.presenceManager.subscribe(
        members: members,
        expiry: expiry,
      );
    } on ChatError catch (e) {
    }
    ```

    <CalloutContainer type="info">
      <CalloutDescription>
        You can subscribe to a maximum of 100 users at each call. The total subscriptions of each user cannot exceed 3,000. Once the number of subscriptions exceed the limit, the subsequent subscriptions with longer durations succeed and replace the existing subscriptions with shorter durations.The subscription duration can be a maximum of 30 days. When the subscription to a user expires, you need to subscribe to this user once again. If you subscribe to a user again before the current subscription expires, the duration is reset.
      </CalloutDescription>
    </CalloutContainer>

    ### Publish a custom presence status [#publish-a-custom-presence-status-2]

    You can call `publishPresence` to publish a custom status. Whenever your presence status updates, the users who subscribe to you receive the `ChatPresenceEventHandler#onPresenceStatusChanged` callback.

    The following code sample shows how to publish a custom status:

    ```dart
    try {
      // description: The custom presence status.
      await ChatClient.getInstance.presenceManager.publishPresence(description);
    } on ChatError catch (e) {
    }
    ```

    ### Listen for presence status updates [#listen-for-presence-status-updates-2]

    Refer to the following code sample to listen for presence status updates:

    ```dart
        // Adds the presence event handler.
        ChatClient.getInstance.presenceManager.addEventHandler(
          "UNIQUE_HANDLER_ID",
          ChatPresenceEventHandler(
            onPresenceStatusChanged: (list) {},
          ),
        );

        ...

        // Removes the presence event handler.
        ChatClient.getInstance.presenceManager.removeEventHandler("UNIQUE_HANDLER_ID");
    ```

    ### Unsubscribe from the presence status of one or more users [#unsubscribe-from-the-presence-status-of-one-or-more-users-2]

    You can call `unSubscribe` to unsubscribe from the presence statuses of the specified users, as shown in the following code sample:

    ```dart
    // memberIds: The ID list of users from whom you unsubscribe.
    try {
      await ChatClient.getInstance.presenceManager.unSubscribe(
        members: members,
      );
    } on ChatError catch (e) {
    }
    ```

    ### Retrieve the list of subscriptions [#retrieve-the-list-of-subscriptions-2]

    You can call `fetchSubscribedMembers` to retrieve the list of your subscriptions in a paginated list, as shown in the following code sample:

    ```dart
    try {
      List subMembers =
          await ChatClient.getInstance.presenceManager.fetchSubscribedMembers();
    } on ChatError catch (e) {
    }
    ```

    ### Retrieve the presence status of one or more users [#retrieve-the-presence-status-of-one-or-more-users-2]

    You can call `fetchPresenceStatus` to retrieve the current presence statuses of the specified users without the need to subscribe to them, as shown in the following code sample:

    ```dart
    // memberIds: The ID list of users whose presence status you retrieve.
    // You can pass in up to 100 user IDs.
    try {
      List list = await ChatClient.getInstance.presenceManager
          .fetchPresenceStatus(members: memberIds);
    } on ChatError catch (e) {
    }
    ```

    
  
      
  
      
  
      
  
      
  
