mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-10-23 06:22:43 +00:00
update name in bot address
This commit is contained in:
1 parent
aa989f61c9
commit
f9c8049dc2
11 files changed
+199
-13
No files matched your search
@@ -7,6 +7,7 @@ This file is generated automatically.
|
||||
- [APIDeleteMyAddress](#apideletemyaddress)
|
||||
- [APIShowMyAddress](#apishowmyaddress)
|
||||
- [APISetProfileAddress](#apisetprofileaddress)
|
||||
- [APISetUserDomain](#apisetuserdomain)
|
||||
- [APISetAddressSettings](#apisetaddresssettings)
|
||||
|
||||
[Message commands](#message-commands)
|
||||
@@ -246,6 +247,53 @@ ChatCmdError: Command error (only used in WebSockets API).
|
||||
---
|
||||
|
||||
|
||||
### APISetUserDomain
|
||||
|
||||
Set or remove SimpleX name of bot address. The name must be registered with the address short link.
|
||||
|
||||
*Network usage*: interactive.
|
||||
|
||||
**Parameters**:
|
||||
- userId: int64
|
||||
- simplexDomain: string?
|
||||
|
||||
**Syntax**:
|
||||
|
||||
```
|
||||
/_set domain <userId>[ <simplexDomain>]
|
||||
```
|
||||
|
||||
```javascript
|
||||
'/_set domain ' + userId + (simplexDomain ? ' ' + simplexDomain : '') // JavaScript
|
||||
```
|
||||
|
||||
```python
|
||||
'/_set domain ' + str(userId) + ((' ' + simplexDomain) if simplexDomain is not None else '') # Python
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
UserProfileUpdated: User profile updated.
|
||||
- type: "userProfileUpdated"
|
||||
- user: [User](./TYPES.md#user)
|
||||
- fromProfile: [Profile](./TYPES.md#profile)
|
||||
- toProfile: [Profile](./TYPES.md#profile)
|
||||
- updateSummary: [UserProfileUpdateSummary](./TYPES.md#userprofileupdatesummary)
|
||||
|
||||
UserProfileNoChange: User profile was not changed.
|
||||
- type: "userProfileNoChange"
|
||||
- user: [User](./TYPES.md#user)
|
||||
|
||||
ChatCmdError: Command error (only used in WebSockets API).
|
||||
- type: "chatCmdError"
|
||||
- chatError: [ChatError](./TYPES.md#chaterror)
|
||||
|
||||
**Errors**:
|
||||
- SimplexDomainNotReady: The name does not resolve to the address short link.
|
||||
|
||||
---
|
||||
|
||||
|
||||
### APISetAddressSettings
|
||||
|
||||
Set bot address settings.
|
||||
|
||||
@@ -81,6 +81,14 @@ chatCommandsDocsData =
|
||||
("APIDeleteMyAddress", [], "Delete bot address.", ["CRUserContactLinkDeleted", "CRChatCmdError"], [], Just UNBackground, "/_delete_address " <> Param "userId"),
|
||||
("APIShowMyAddress", [], "Get bot address and settings.", ["CRUserContactLink", "CRChatCmdError"], [], Nothing, "/_show_address " <> Param "userId"),
|
||||
("APISetProfileAddress", [], "Add address to bot profile.", ["CRUserProfileUpdated", "CRUserProfileNoChange", "CRChatCmdError"], [], Just UNInteractive, "/_profile_address " <> Param "userId" <> " " <> OnOff "enable"),
|
||||
( "APISetUserDomain",
|
||||
[],
|
||||
"Set or remove SimpleX name of bot address. The name must be registered with the address short link.",
|
||||
["CRUserProfileUpdated", "CRUserProfileNoChange", "CRChatCmdError"],
|
||||
[TD "CESimplexDomainNotReady" "The name does not resolve to the address short link"],
|
||||
Just UNInteractive,
|
||||
"/_set domain " <> Param "userId" <> Optional "" (" " <> Param "$0") "simplexDomain"
|
||||
),
|
||||
("APISetAddressSettings", [], "Set bot address settings.", ["CRUserContactLinkUpdated", "CRChatCmdError"], [], Just UNInteractive, "/_address_settings " <> Param "userId" <> OnOffParam "pq_ratchet" "pqRatchet" Nothing <> " " <> Json "settings")
|
||||
]
|
||||
),
|
||||
@@ -438,7 +446,6 @@ undocumentedCommands =
|
||||
"APISetServerOperators",
|
||||
"APISetUserContactReceipts",
|
||||
"APISetUserGroupReceipts",
|
||||
"APISetUserDomain",
|
||||
"APISetUserServers",
|
||||
"APISetUserUIThemes",
|
||||
"APIStandaloneFileInfo",
|
||||
|
||||
Reference in new issue
Block a user