-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
commit a9e2f1f Author: GitHub Action Bot <[email protected]> Date: Tue Nov 19 00:24:01 2024 +0000 sdk-1a6eea7-0.0.110 commit d8a0cc1 Author: GitHub Action Bot <[email protected]> Date: Tue Nov 19 00:23:51 2024 +0000 docs for version sdk-1a6eea7-
- Loading branch information
Showing
25 changed files
with
188 additions
and
68 deletions.
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "$schema": "node_modules/lerna/schemas/lerna-schema.json", | ||
| "version": "0.0.109", | ||
| "version": "0.0.110", | ||
| "packages": ["packages/*", "protocol"], | ||
| "npmClient": "yarn" | ||
| } |
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
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "name": "@river-build/dlog", | ||
| "version": "0.0.109", | ||
| "version": "0.0.110", | ||
| "packageManager": "[email protected]", | ||
| "type": "module", | ||
| "main": "dist/index.js", | ||
|
|
||
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
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
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 |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| title: useCreateDm | ||
| --- | ||
| A hook that allows you to create a new direct message (DM). | ||
|
|
||
| ## Imports | ||
|
|
||
| ```ts | ||
| import { useCreateDm } from '@river-build/react-sdk' | ||
| ``` | ||
|
|
||
| ## Definition | ||
|
|
||
| ```ts | ||
| function useCreateDm( | ||
| config?: ActionConfig<Dms['createDM']>, | ||
| ): { | ||
| data: { | ||
| streamId: string; | ||
| } | undefined; | ||
| error: Error | undefined; | ||
| isPending: boolean; | ||
| isSuccess: boolean; | ||
| isError: boolean; | ||
| createDM: (userId: string, streamSettings?: PlainMessage<StreamSettings> | undefined) => Promise<{ | ||
| streamId: string; | ||
| }>; | ||
| } | ||
| ``` | ||
|
|
||
| **Source:** [useCreateDm](https://github.com/river-build/river/blob/main/packages/react-sdk/src/useCreateDm.ts) | ||
|
|
||
| ## Parameters | ||
|
|
||
| ### config | ||
|
|
||
| - **Type:** `ActionConfig<Dms['createDM']>` | ||
| - **Optional** | ||
|
|
||
| The action config. | ||
|
|
||
| ## Return Type | ||
|
|
||
| An object containing the `createDM` action and the rest of the action result. | ||
|
|
||
| ```ts | ||
| { | ||
| data: { | ||
| streamId: string; | ||
| } | undefined; | ||
| error: Error | undefined; | ||
| isPending: boolean; | ||
| isSuccess: boolean; | ||
| isError: boolean; | ||
| createDM: (userId: string, streamSettings?: PlainMessage<StreamSettings> | undefined) => Promise<{ | ||
| streamId: string; | ||
| }>; | ||
| } | ||
| ``` |
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 |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| title: useCreateGdm | ||
| --- | ||
| A hook that allows you to create a new group direct message (GDM). | ||
|
|
||
| ## Imports | ||
|
|
||
| ```ts | ||
| import { useCreateGdm } from '@river-build/react-sdk' | ||
| ``` | ||
|
|
||
| ## Definition | ||
|
|
||
| ```ts | ||
| function useCreateGdm( | ||
| config?: ActionConfig<Gdms['createGDM']>, | ||
| ): { | ||
| data: { | ||
| streamId: string; | ||
| } | undefined; | ||
| error: Error | undefined; | ||
| isPending: boolean; | ||
| isSuccess: boolean; | ||
| isError: boolean; | ||
| createGDM: (userIds: string[], channelProperties?: EncryptedData | undefined, streamSettings?: PlainMessage<StreamSettings> | undefined) => Promise<{ | ||
| streamId: string; | ||
| }>; | ||
| } | ||
| ``` | ||
|
|
||
| **Source:** [useCreateGdm](https://github.com/river-build/river/blob/main/packages/react-sdk/src/useCreateGdm.ts) | ||
|
|
||
| ## Parameters | ||
|
|
||
| ### config | ||
|
|
||
| - **Type:** `ActionConfig<Gdms['createGDM']>` | ||
| - **Optional** | ||
|
|
||
| The action config. | ||
|
|
||
| ## Return Type | ||
|
|
||
| An object containing the `createGDM` action and the rest of the action result. | ||
|
|
||
| ```ts | ||
| { | ||
| data: { | ||
| streamId: string; | ||
| } | undefined; | ||
| error: Error | undefined; | ||
| isPending: boolean; | ||
| isSuccess: boolean; | ||
| isError: boolean; | ||
| createGDM: (userIds: string[], channelProperties?: EncryptedData | undefined, streamSettings?: PlainMessage<StreamSettings> | undefined) => Promise<{ | ||
| streamId: string; | ||
| }>; | ||
| } | ||
| ``` |
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
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
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
Oops, something went wrong.