Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc about how to get an address from an inbox ID #113

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions docs/pages/inboxes/build-inbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,92 @@ let orderFilteredConversations = try await client.conversations.listGroups(conse

:::

## Retrieve a wallet address from an inbox ID

An XMTP inbox ID can have an array of addresses associated with it. To retrieve an address from an inbox ID, use the `inboxState` method. This retrieves the current state of the inbox, which includes the primary address associated with it.

### Best practices

When displaying an address for an inbox ID, consider these best practices:

- For 1:1 chats: Display the primary address or name associated with the inbox ID.
Copy link
Collaborator Author

@jhaaaa jhaaaa Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the primary address the recovery address of the user who initiated the chat?

A 1:1 chat can have a name?

How to set it and get it?

- For group chats: Display the name of the group, or enable users to choose the one address they want to display from the associated addresses.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to this doc to show how to get a group chat name? https://docs.xmtp.org/inboxes/group-metadata#get-a-group-chat-name


Displaying multiple addresses for an inbox ID can create a misleading UX for users. For example, it could make a 1:1 chat appear to have more than two participants.

### Retrieve the state of a single inbox ID

:::code-group

```tsx [Browser]
need code sample
```

```tsx [Node]
need code sample
```

```tsx [React Native]
// @param {boolean} refreshFromNetwork - If you want to refresh the current state of in the inbox from the network or not.
// @returns {Promise<InboxState>} A Promise resolving to a InboxState.

async inboxState(refreshFromNetwork: boolean): Promise<InboxState> {
return await XMTPModule.getInboxState(
this.installationId,
refreshFromNetwork
)
}
```

```tsx [Kotlin]
need code sample
```

```tsx [Swift]
need code sample
```

:::

### Retrieve the state of multiple inbox IDs

:::code-group

```tsx [Browser]
need code sample
```

```tsx [Node]
need code sample
```

```tsx [React Native]
// @param {InboxId[]} inboxIds - The inboxIds to get the associate inbox states for.
// @param {boolean} refreshFromNetwork - If you want to refresh the current state the inbox from the network or not.
// @returns {Promise<InboxState[]>} A Promise resolving to a list of InboxState.

async inboxStates(
refreshFromNetwork: boolean,
inboxIds: InboxId[]
): Promise<InboxState[]> {
return await XMTPModule.getInboxStates(
this.installationId,
refreshFromNetwork,
inboxIds
)
}
```

```tsx [Kotlin]
need code sample
```

```tsx [Swift]
need code sample
```

:::

## Stream conversations and messages

### Stream all group chats and DMs
Expand Down