-
Notifications
You must be signed in to change notification settings - Fork 27
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
jhaaaa
wants to merge
1
commit into
main
Choose a base branch
from
get-address
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
- 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?