dandri/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2026-07-09 23:11:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
712effe34f55cefee3c8d0e9a71bc7327fadf67a
simplex-chat/bots/api/TYPES.md
T
sh 10a814694c core, ui: support SimpleX names (#7045) 
* deps: bump simplexmq for ConnectTarget

* chat: migration adds simplex_name to contacts, groups, connections

Nullable TEXT column on all three tables, with partial indexes on
contacts(user_id, simplex_name) and groups(user_id, simplex_name)
for the upcoming connectPlanName lookup. connections.simplex_name
is the transient carrier from APIConnect -> XInfo handler, where
the value is copied to contacts.simplex_name at delayed create.
No reads or writes yet - column threading lands in subsequent commits.

* tests: provide namesConfig = Nothing in smpServerCfg

Follow-up to the simplexmq pin bump (ee0a45e9). The new
namesConfig :: Maybe NamesConfig field on ServerConfig (introduced
in simplexmq's namespace branch) needs to appear in the test
fixture's record literal, otherwise the test suite fails to compile
under -Werror. Disabled by default (Nothing).

* chat: thread simplexName through Contact/GroupInfo/Connection records

Adds `simplexName :: Maybe SimplexNameInfo` to the three records and
extends every SELECT path that reconstructs them to read the new
column. Decoded via eitherToMaybe . strDecode . encodeUtf8 (the
codebase's established pattern for Maybe Text -> typed-decode fields),
extracted as decodeSimplexName helper since the chain appears in
toContact / toContact' / toGroupInfo / toConnection. INSERT paths
still write Nothing - the write-side wiring lands in the next commit
(Task 7).

* deps: bump simplexmq for SimplexNameInfo FromField/ToField

* chat: cross-reference groupInfoQueryFields and getGroupAndMember_

Two helpers redundantly maintain the same g.* column list. A future
g.* addition must be applied to both sites; the cross-reference
comments flag this for maintainers. A proper refactor (reusing
groupInfoQueryFields from Connections.hs's inline SELECT) is out of
scope for this branch.

* chat: persist simplexName on prepare and connect-via-plan write paths

createPreparedContact/createPreparedGroup gain a Maybe SimplexNameInfo
parameter that they write to contacts.simplex_name / groups.simplex_name
directly. createConnection_ writes to connections.simplex_name as a
transient carrier for the connect-via-plan path. The XInfo handler
in Library/Subscriber.hs reads the connection's simplexName and passes
it to createDirectContact so the final contact row captures the name.

All current callers pass Nothing; the actual flow lights up when
APIConnectPlan accepts ConnectTarget and connectPlanName threads the
name through (later commits in this branch).

Uses the upstream ToField SimplexNameInfo (simplexmq 0b334b66) for
writes; reads continue to go via the soft-degradation helper.

* chat: APIConnectPlan accepts ConnectTarget; connectPlanName looks up by name

APIConnectPlan/Connect flip from Maybe AConnectionLink to Maybe ConnectTarget.
connectPlan dispatches CTLink -> connectPlanLink (the prior body, renamed)
and CTName -> connectPlanName (new) which looks the name up against
contacts.simplex_name and groups.simplex_name via the new
getContactBySimplexName / getGroupInfoBySimplexName store helpers.

The hit path returns the contact's / group's stored conn link from
preparedContact / preparedGroup; missing prepared state or unknown
names return CEInvalidConnReq. RSLV on-chain resolution is out of
scope for this branch -- known-name lookup is enough for conversation
display, search, and external-link share.

connLinkP_ parser is unchanged: APIConnect's preparedLink_ stays
ACreatedConnLink-shaped, and the Connect / APIConnectPlan parsers
already use inline strP for ConnectTarget without going through the
helper.

Directory.Service call sites updated to wrap their AConnectionLink in
CTLink when invoking APIConnectPlan.

* chat: surface simplexName in conversation view + JSON output

viewConnectionPlan now shows the simplex name beneath known
contacts/groups (ILPKnown, CAPKnown, CAPContactViaAddress, GLPKnown
active/prepared/deleted). The TH-derived Contact / GroupInfo JSON
instances automatically expose `simplexName` (omitted when Nothing
per defaultJSON's omitNothingFields), which unblocks client-side
display and search.

No JSON test added: there is no Contact-level JSON test module in
this codebase; coverage is already provided by defaultJSON's
omitNothingFields = True behaviour.

Server-side substring search has no existing pattern in this
codebase; client renderers index simplexName themselves once it
appears in the JSON shape.

External-link share (preferring simplex:/name… form over the raw
link when the contact has a simplexName) lands in the next commit.

* chat: share/copy output prefers simplexName when present

When a contact or group has a simplex_name stored, the share-link
render path emits the canonical simplex:/name... URI (via strEncode)
instead of the underlying connection link. Falls back to the existing
link rendering when simplexName is Nothing.

Final commit of the ConnectTarget plumbing chain: end-to-end users
can now (a) connect via @alice.simplex / #group.simplex with the
agent layer carrying the name, (b) see the simplex name on the
contact/group records and in viewConnectionPlan, (c) share the
contact using the namespace-canonical form rather than the raw URI.

* deps: bump simplexmq for boundedNonSpace + drop unused FromField

* chat: simplex_name partial indexes are UNIQUE

A simplex name is a stable, per-user identity (one name → one contact
or group). Without a unique constraint, a later writer that populates
the column twice for the same name would silently produce two matching
rows, and getContactBySimplexName/getGroupInfoBySimplexName would
return whichever the planner picks first.

Promote the partial indexes added in M20260603 to UNIQUE before any
caller wires the writes. Predicate (WHERE simplex_name IS NOT NULL)
already scopes the constraint to rows that opted in.

* chat: regen Postgres schema dump for UNIQUE simplex_name indexes

Follow-up to f71c579c. The SchemaDump test runs against SQLite only;
the parallel PostgresSchemaDump suite gates on -fclient_postgres and
a running localhost PG instance, which this environment doesn't have.
Updated the Postgres schema dump by hand to mirror the migration
change (two lines: CREATE INDEX → CREATE UNIQUE INDEX).

* chat: CESimplexNameNotFound for name lookup misses

connectPlanName now distinguishes "name not found" from "connection
link is invalid". CEInvalidConnReq's message ("Connection link is
invalid, possibly it was created in a previous version") was
misleading when a user typed @alice.simplex against a database that
simply has no contact by that name.

The two "missing prepared link" cases stay on CEInvalidConnReq —
the lookup found a row but the stored link is unusable, which is
closer to the existing semantics. The two truly-missing cases
(no contact found / no group found) move to CESimplexNameNotFound,
which also surfaces the name back to the client for a precise UX.

* chat: exclude soft-deleted contacts from idx_contacts_simplex_name

The lookup `getContactBySimplexName` (Store/Direct.hs:781) filters
`AND deleted = 0`, but the index predicate `WHERE simplex_name IS NOT
NULL` covered tombstoned rows too. Forward-compat trap: once writers
land a non-Nothing simplex_name, soft-deleting a contact would block
re-claiming its name (UNIQUE conflict) even though the lookup reports
the slot as free.

Tighten the partial-index predicate to also require deleted = 0 so the
constraint scope matches the live-lookup scope. Groups have no soft-
delete column, so their index stays as-is.

* chat: connectPlanName dispatches on nameType first

Previously the function always probed contacts.simplex_name first and
fell through to groups for NTPublicGroup misses. But the discriminator
(`@`/`#`) is embedded in the stored bytes via strEncode, so an
`#group.simplex` lookup can never match a contact row. Reorder to
case on nameType up front, saving one DB query and one withFastStore
transaction acquire on the group path.

* chat: CESimplexNameUnprepared for found-but-no-link cases + member-removed filter

connectPlanName previously threw CEInvalidConnReq when a name lookup
hit a contact / group row whose preparedContact / preparedGroup was
NULL. The error message ("Connection link is invalid, possibly it was
created in a previous version") was wrong: the name resolved fine,
the device just has no link material to reconnect via (typical for a
contact created via the XInfo handler rather than the prepare path).
Introduce CESimplexNameUnprepared SimplexNameInfo for this case.

Also mirror the link-based path's gPlan (Commands.hs:4133) for groups
whose membership state is GSMemRemoved — return CESimplexNameNotFound
rather than GLPKnown for a removed-member group, since GLPKnown for
removed members would be inconsistent with how /_connect plan over a
short link handles the same situation.

* chat: fix stale CRITICAL comment in saveConnInfo

Comment claimed SEDBException is re-thrown as CRITICAL but only
SEDBBusyError is (via the `critical` helper at Subscriber.hs:136
and the showCritical branch at :1695). Updated to describe the actual
behaviour.

* chat: fix misleading decodeSimplexName docstring

The comment described "@alice.simplex" as the column's surface form,
but ToField SimplexNameInfo writes the canonical strEncode output
("simplex:/name@alice.simplex"). Aligns the docstring with what the
column actually holds.

* chat: drop redundant T.unpack in CESimplexName* error rendering

plain has a Text instance (verified by sibling simplexNameLine at
View.hs:2176 which uses it directly). The T.unpack in the new error
renderings was inconsistent with the same-feature helper. Cosmetic
cleanup.

* deps: bump simplexmq for resolveSimplexName

* chat: simplexName field on Profile, GroupProfile, LocalProfile

Adds a Maybe SimplexNameInfo field to the wire-level Profile and
GroupProfile (and their DB sibling LocalProfile). JSON instances are
TH-derived with omitNothingFields = True, so the new optional field is
auto-handled and old peers / old JSON without the key decode as Nothing.

Existing record-construction sites are set to simplexName = Nothing as
a placeholder. Outgoing dissemination (userProfileDirect /
userProfileInGroup) and incoming persistence wire-up land in follow-up
commits. redactedMemberProfile passes the field through, matching how
peerType is preserved.

* chat: load LocalProfile.simplexName from simplex_name column

Populate the embedded LocalProfile.simplexName field for the user's own
profile and for peer Contact / GroupInfo from the existing simplex_name
columns on contacts and groups. Previously every DB read set this field
to Nothing (Task 1 placeholder), so downstream consumers that work off
LocalProfile / GroupProfile (e.g., userProfileDirect / userProfileInGroup
that build outgoing XInfo / XGrpInfo via fromLocalProfile) saw Nothing
unconditionally.

Scope is limited to the rows where the simplex_name column actually
exists: contacts (per-user) and groups (per-user). Sites that only read
contact_profiles / group_profiles (toContactRequest, toContactProfile,
toGroupProfile, rowToLocalProfile) remain Nothing; Task 3 adds the
profile-table columns and wires them up.

* chat: test outgoing Profile carries simplexName from User profile

userProfileDirect, userProfileInGroup' and redactedMemberProfile already
pass simplexName through via fromLocalProfile (Task 1) once the embedded
LocalProfile field is populated (previous commit). Lock that behavior in
with focused unit tests:

- userProfileDirect with Just simplexName -> wire Profile.simplexName Just
- userProfileDirect with Nothing -> wire Nothing
- userProfileDirect with an incognito Profile overlay -> wire Nothing
  (incognito identity must not leak the user's registered name)
- userProfileInGroup' pass-through
- redactedMemberProfile pass-through (forwarded member profiles)

* chat: clarify groups.simplex_name stopgap comment

Drop the asymmetric toContact comment (the mirror is now obvious post-Task-1)
and rewrite the toGroupInfo stopgap comment to reflect the actual semantics:
groups.simplex_name is per-user locally-known, mirrored into groupProfile as a
stopgap until group_profiles.simplex_name lands.

* chat: add simplex_name to contact_profiles and group_profiles

Adds nullable simplex_name TEXT column and partial UNIQUE
(user_id, simplex_name) index to both contact_profiles and group_profiles
tables. Distinct from contacts.simplex_name / groups.simplex_name
(M20260603), which carry the user's locally-known label set by the
prepare-via-name path; the new columns will carry the peer's broadcast
claim received via XInfo / XGrpInfo (wired up in following commits).

* chat: persist peer-claimed simplexName from incoming profiles

Write paths:
- updateContactProfile_' / updateGroupProfile_ now set the new
  contact_profiles.simplex_name / group_profiles.simplex_name columns
  from Profile.simplexName / GroupProfile.simplexName respectively.
- createContact_ INSERT writes Profile.simplexName to the new
  contact_profiles column (separate from the existing simplexName arg,
  which still writes contacts.simplex_name — the user's locally-known
  label).

Read paths (closing Task 2's deferred sites):
- toContact splits simplex_name reads: Contact.simplexName from
  contacts.simplex_name (existing); LocalProfile.simplexName from
  contact_profiles.simplex_name (new column).
- toGroupInfo similarly splits: GroupInfo.simplexName from
  groups.simplex_name; groupProfile.simplexName from
  group_profiles.simplex_name.
- ProfileRow / rowToLocalProfile, toContactRequest, getUserContactProfiles,
  toGroupProfile, getProfileById, groupMemberQuery, getGroupAndMember_,
  saveRcvChatItem-related quotes — all extended to read p.simplex_name
  and decode it into LocalProfile.simplexName / GroupProfile.simplexName.

Conflict handling (Decision B):
- clearConflictingContactProfileSimplexName_ / *Group* helpers do an
  atomic UPDATE-with-RETURNING that NULLs simplex_name on any other
  row in the same user that would collide on the partial UNIQUE index,
  returning the displaced row's display_name.
- updateContactProfileWithConflict / updateGroupProfileWithConflict
  bundle clear+update in one transaction.
- processContactProfileUpdate / xGrpInfo invoke the *WithConflict
  variants and emit CEvtSimplexNameConflict when a displacement
  happened (with the claiming and displaced display names).

Adds ChatEvent CEvtSimplexNameConflict and SimplexNameConflictEntity
(SNCEContact / SNCEGroup) with JSON instances and View.hs rendering.

* chat: fix review findings on simplex_name persistence

- updateUserProfile no longer writes contact_profiles.simplex_name on
  the user's own row (the column is reserved for peer claims; the user's
  broadcastable name lives on contacts.simplex_name via uct.simplex_name).
- updateMemberContactProfile_'/Reset_' now write simplex_name; new
  updateMemberProfileWithConflict / updateContactMemberProfileWithConflict
  variants run conflict-clear and return the displaced name, with
  processMemberProfileUpdate emitting CEvtSimplexNameConflict.
- createContact_ runs conflict-clear before INSERT to avoid UNIQUE
  constraint violations on first-write peer collisions, returning the
  displaced name; createPreparedContact / createDirectContact thread it
  through to APIPrepareContact and saveConnInfo XInfo for event emission.
- groups conflict-clear takes ProfileId directly (avoids the NOT IN (NULL)
  silent-noop edge case when groups.group_profile_id is ON DELETE SET NULL).
- Moves clearConflictingContactProfileSimplexName_ to Shared.hs so
  createContact_ can call it without inducing a circular import.

* chat: resolveOnUserServers iterates user SMP servers for RSLV

* chat: connectPlanName falls back to RSLV when local lookup misses

* chat: RSLV-resolved NameRecord dispatched through prepared row

dispatchResolvedRecord now picks the first nrContactLinks (NTContact) or
nrChannelLinks (NTPublicGroup) entry from the resolved record, decodes it
as AConnShortLink, fetches the short-link data, and eagerly calls
createPreparedContact / createPreparedGroup with the simplex_name set.

Returning CPContactAddress (CAPKnown ct) / CPGroupLink (GLPKnown g ...)
mirrors the local-store-hit branch of connectPlanName: hit and miss
converge on the same plan shape, so the connectWithPlan caller cannot
distinguish where the prepared row came from. Threading uses the
existing Maybe SimplexNameInfo parameter added in c6f26150 for the
local-prepare path -- no new write path or transient carrier.

Pure helper firstNameLink is extracted and exported so the link-picker
contract is testable without a DB / agent. ResolveNameTests gains five
cases covering the per-type selection, the first-link policy, and the
empty-list to CESimplexNameNotFound collapse.

* chat: regen query plans after simplex_name plumbing

* chat: register ConnectTarget + CEvtSimplexNameConflict in bot docs

Bot API docs generator failed with "Undefined type: ConnectTarget"
since f2394d121 (prior plan) flipped APIConnectPlan/Connect from
Maybe AConnectionLink to Maybe ConnectTarget without updating
bots/src/API/Docs/*. Also adds SimplexNameConflictEntity (new in
cd0de9659) and documents the CEvtSimplexNameConflict event for
peer-name displacement notifications. Regenerates the affected
markdown / TypeScript / Python artefacts.

* deps: bump simplexmq for NameRecord reshape; update consumers

simplexmq 5ee014dd reshaped NameRecord to align with the Python resolver
JSON: nrChannelLinks/nrContactLinks (lists of NameLink) became
nrSimplexChannel/nrSimplexContact (Maybe Text); nrDisplayName became
nrName; nrResolver was added; the NameLink wrapper type and nrIsTest/
nrExpiry/nrAdminAddress/nrAdminEmail fields were dropped.

Update dispatchResolvedRecord destructure and firstNameLink signature
to the new Maybe Text shape, and refresh the ResolveNameTests fixtures
and assertions accordingly.

* chat: resolveOnUserServers iterates only on transport errors

Privacy: every miss previously broadcast the candidate name to every
enabled SMP server. Now only NETWORK / TIMEOUT failures fall through
to the next server; definite resolver answers (NAME / AUTH / CMD
PROHIBITED / other ERR) stop iteration.

* chat: document why groups simplex_name index has no soft-delete filter

The contacts simplex_name index filters on (deleted = 0); the groups
index has no analogous filter because the groups table has no `deleted`
column. Groups are hard-deleted by deleteGroup, so the asymmetry is
intentional. The remaining "removed member, row retained" edge case is
flagged in the lookup comment for follow-up.

* chat: document connections.simplex_name as transient carrier

Audit flagged the column as "INSERTed but never UPDATEd". This is by
design per the prior plan's connect-via-plan flow: the column is a
transient carrier between connection-creation and contact-creation.
After the Contact row is created via XInfo handling, contacts.simplex_name
is the source of truth and the connections value is a historical snapshot.
Documents the intent so future readers don't reflag it.

* chat: extract surfaceSimplexNameConflict helper

Six call sites duplicated the same forM_ ((,) <$> claim <*> displaced)
shape emitting CEvtSimplexNameConflict. Extract to a single helper so
future call sites don't drift on whether to emit, and so the conflict
event shape change (post-Task-3 SimplexNameConflictEntity split into
SNCEContact / SNCEGroup) propagates through one site.

* chat: APIVerifySimplexName command + CEvtSimplexNameUnverified warning

Addresses the TOFU vulnerability where peer-claimed simplex_name was
accepted unverified. Adds:

- contacts.simplex_name_verified_at + groups.simplex_name_verified_at
  (M20260606_simplex_name_verified)
- APIVerifySimplexName ChatRef command: RSLV-resolves the claimed name
  and compares the resolved link to the peer's stored connection link;
  on match writes verified_at and emits CEvtSimplexNameVerified;
  on mismatch emits CEvtSimplexNameVerifyFailed
- CEvtSimplexNameUnverified passive warning emitted on incoming XInfo /
  XGrpInfo when a name claim arrives without a current verification
- updateContactProfileWithConflict / updateGroupProfileWithConflict
  clear simplex_name_verified_at whenever the peer's claim transitions
  (any value change including Nothing<->Just): the prior verification
  was bound to the prior claim.

UI can surface the unverified indicator next to a contact / group's
name, and prompt the user to invoke the verify command. This shifts
the security model from "TOFU + last-writer-wins" to "TOFU + on-demand
RSLV verification".

* chat: register APIVerifySimplexName + verify events in bot docs

ebe90f716 added the verify command + events + SimplexNameVerifyFailReason
type without touching bots/src/API/Docs/. Mirrors commit 0d7ea8061 which
addressed the same gap for ConnectTarget. Regenerates the affected
markdown / TypeScript / Python artefacts.

* chat: bump simplexmq pin + document cross-table simplex_name discriminator

Pin bump 5ee014dd -> c9c2d19 picks up the 8 simplexmq commits since the
last bump (parseBare lowercase fix, forwarded-param cleanup, ServerTests
+ agent end-to-end tests, TldRegistries removal, SNRC ABI decoder,
NameRecord/NameOwner module extraction).

Adds a brief comment on clearConflictingContactProfileSimplexName_
explaining why the audit's flagged cross-table collision (between
contact_profiles.simplex_name and group_profiles.simplex_name) is
structurally impossible: SimplexNameInfo's strEncode prefixes contact
names with '@' and group names with '#', so the stored bytes never
overlap between the two tables.

Query-plan regen deferred (the test is non-deterministic in CI / dev
sandbox — see prior 6c990696c).

* deps: bump simplexmq for HTTP resolver; adapt NameRecord consumers

simplexmq 92b3d049 reshaped NameRecord text fields from Maybe Text to
Text (empty string sentinel). Adapt firstNameLink to take Text directly
and treat T.null as "absent". dispatchResolvedRecord destructure
unchanged; passes the text values straight through. apiVerifySimplexName
switches from Just/Nothing pattern to a T.null guard with the same UX.
Test fixtures updated.

* deps: bump simplexmq for multi-link NameRecord; adapt consumers

* core: treat RSLV CMD UNKNOWN as no name-resolution support

* core: fix contact-by-connection query missing simplex_name_verified_at

* deps: update sha256map for simplexmq f555e9af pin

* core: iterate past RSLV-unsupported name servers

* core: filter RSLV servers by operator enablement

* core: align resolver docs/tests with RSLV errors

* deps: bump simplexmq to df1aa24c

* refactor(names): agent resolution + one error type

Adopt the simplexmq names rework (PR #7045): name resolution is now
owned by the agent (resolveSimplexName picks a names-role server), so
the chat-side iteration is removed - delete ResolveError,
iterateResolvers, resolveOnUserServers, enabledSMPServersForUser and
resolveErrorToChatError.

One error type: resolver/agent failures flow through ChatErrorAgent;
remove the CEvtSimplexName* events, SimplexNameVerifyFailReason,
SimplexNameConflictEntity and CESimplexNameResolverUnavailable.
APIVerifySimplexName returns CRSimplexNameVerified (verified::Bool),
mirroring CRConnectionVerified. connectPlan handles the name target
directly; updateProfile WithConflict aliases collapsed into the plain
functions.

Add the per-operator "names" SMP server role (migration
20260612_smp_role_names, official operator on by default) feeding
ServerRoles.names -> UserServers.nameSrvs.

Bump simplexmq pin to ce69adfd and regenerate sha256map.nix.

* fix(store): match chat_schema.sql to sqlite 3.46+ indent

The schema-dump test renders the partial-index WHERE via the sqlite3
CLI; sqlite >=3.46 wraps a multi-condition WHERE onto two lines
("IS NOT NULL" + indented "AND ...") where 3.45 kept it on one. The
committed schema was generated with 3.45, so CI (newer sqlite) failed
the comparison on idx_contacts_simplex_name. Regenerated with the
newer formatter; only that one WHERE clause changes.

* feat(operators): warn when no server resolves names

Mirror USWNoChatRelays: validateUserServers emits USWNoNamesServers
when no enabled server of an enabled operator carries the SMP names
role. noNamesServersWarns is self-contained with local predicates,
matching the sibling noChatRelaysWarns; noServersErrs is untouched.

* test(operators): expect USWNoNamesServers warning in no-servers cases

* fix(store): single-line simplex_name WHERE to match CI sqlite (<=3.45)

* chore: bump simplexmq pin to 6843b14c

* refactor(store): consolidate names migrations into one

Unshipped feature - merge the four incremental simplex_name migrations
(0603/0604/0606/0612) into a single M20260603_simplex_name. The combined
UP applies the ALTERs/indexes in the same order, so the resulting schema
is byte-identical (verified by SchemaDump on SQLite and pg_dump on Postgres).

* update simplexmq

* plan for name resolution

* update types and schema

* simpler resolution, name proofs

* simplexmq

* generate bot types, schema, unStrJSON, fix tests

* ad hoc link comparison, create short link

* update simplexmq

* remove same link, use simplexmq instead

* split verify API for contacts and public groups

* remove comment

* simplify warnings

* test: remove unused

* remove cute language

* type name

* remove spurious comments

* refactor setting user name

* refactor setting user name

* remove trivial tests

* refactor

* remove tests using pre-short-link addresses

* rename

* move names

* bots api

* refactor more

* refactor

* refactor to another type

* load own names

* read short links when looking up by name

* renames

* refactor verification

* mapM_

* update api types

* change field for name

* rename columns

* api types, schema

* renames

* fix links

* simplify

* remove comments

* rename fields

* simplify

* remove proof from channel addres

* refactor

* name resolution test

* change tests

* fix tests

* fix tests

* fix plan for names

* test

* test verification status

* bot api

* fix tests

* update bot api types

* query plan

* add api for setting public group access

* android, desktop, ios: connect via SimpleX name (#7068)

* android, desktop, ios: connect via SimpleX name

* android, desktop, ios: open known contact on name lookup; surface prepared contact

Name search opens the contact (not list-filter); resolved/prepared contacts and groups are added to the chat list so they're visible and openable. Kotlin compile-verified; iOS edits pattern-matched, pending Xcode build.

* feat(names): UI names role + agent NAME error

Parity with the core names rework (#7045):

- Add `names` to ServerRoles (Android + iOS) and a per-operator
  "To resolve names" toggle under the SMP section (xftp has no names
  role; the shared ServerRoles field stays false there).
- Mirror the new agent error: NameErrorType + a NAME case on both
  AgentErrorType and ProtocolErrorType (the SMP ErrorType mirror), so
  the new SMP/agent NAME errors decode instead of crashing the decoder.
- Remove ChatErrorType.SimplexNameResolverUnavailable (deleted in core)
  and repoint its "name resolution unavailable" alert to the agent
  NAME NO_SERVERS error, reusing the existing strings.

Android (multiplatform) compiles clean; iOS mirrors the same changes
(builds in Xcode).

* feat(names): UI warning when no server resolves names

Mirror core USWNoNamesServers: add the NoNamesServers variant to
UserServersWarning (Kotlin sealed class + Swift enum) and its
globalWarning / globalServersWarning branch, rendered by the existing
ServersWarningFooter / ServersWarningView. Matches the noChatRelays
warning exactly.

* fix(servers): show all validation errors and warnings, not just the first

globalServersError/Warning returned only the first entry, so a second
warning (e.g. no names servers behind no chat relays) or a second error
(e.g. no XFTP servers behind no SMP servers) was never displayed. Make
them return all entries (globalServersErrors/Warnings) and render one
footer row each, across the three combined-footer views. Per-protocol
SMP/XFTP footers are unchanged.

* docs(names): add SimpleX name UI plan

* feat(names): add name model fields + SimplexName helpers

* feat(names): verify + set-name API & responses

* docs(names): bump core sync to 5008b4e62

* feat(names): show name + verification on chat info

* feat(names): add Verify SimpleX names privacy toggle

* feat(names): add set-name screens (user + channel)

* update ui

* fix kotlin

* fix codable

* fix ios

* fix errors

* api in UI

* send name as string in protocol

* update simplexmq, capitalize

* verify that name is in profile for own and known contacts and channels as condition of name resolution

* update simplexmq

---------

Co-authored-by: Evgeny Poberezkin <evgeny@poberezkin.com>
Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com>

* add log

* bot types

* finalize renames, ui alerts

* more renames

* kotlin alerts

* show set name

* alerts

* texts, icons, footers

* move JSON parsing to a persistent thread with large stack

* simplexmq

* use uikit alerts

* remove comment

* move name verification to more privacy

* change icon on verify names setting

* verify name proof

* nix shas

* show verified names

* better alert when saving names

* revert breaking field name change

* simplexmq

* clean up

* remove unused

* remove empty line

* fix error

* simplify

* use domain without prefix in profiles and in database, rename fields and types

* rename types

* fix JSON name

* pass verified domain to prepare API

* fix prepare api

* fix ios encoding

* enable name resolution via Flux servers

* fix test

---------

Co-authored-by: Evgeny Poberezkin <evgeny@poberezkin.com>
Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com>
2026-07-03 12:51:52 +01:00

69 KiB
Raw Blame History

API Types

This file is generated automatically.

ACIReaction

Record type:

AChat

Record type:

AChatItem

Record type:

AddRelayResult

Record type:

AddressSettings

Record type:

AgentCryptoError

Discriminated union type:

DECRYPT_AES:

  • type: "DECRYPT_AES"

DECRYPT_CB:

  • type: "DECRYPT_CB"

RATCHET_HEADER:

  • type: "RATCHET_HEADER"

RATCHET_SYNC:

  • type: "RATCHET_SYNC"

AgentErrorType

Discriminated union type:

CMD:

CONN:

NO_USER:

  • type: "NO_USER"

SMP:

  • type: "SMP"
  • serverAddress: string
  • smpErr: ErrorType

NTF:

  • type: "NTF"
  • serverAddress: string
  • ntfErr: ErrorType

XFTP:

FILE:

NO_NAME_SERVERS:

  • type: "NO_NAME_SERVERS"

PROXY:

  • type: "PROXY"
  • proxyServer: string
  • relayServer: string
  • proxyErr: ProxyClientError

RCP:

BROKER:

AGENT:

NOTICE:

  • type: "NOTICE"
  • server: string
  • preset: bool
  • expiresAt: UTCTime?

INTERNAL:

  • type: "INTERNAL"
  • internalErr: string

CRITICAL:

  • type: "CRITICAL"
  • offerRestart: bool
  • criticalErr: string

INACTIVE:

  • type: "INACTIVE"

AutoAccept

Record type:

  • acceptIncognito: bool

BadgeInfo

Record type:

  • badgeType: BadgeType
  • badgeExpiry: UTCTime?
  • badgeExtra: string

BadgeProof

Record type:

  • badgeKeyIdx: int
  • presHeader: string
  • proof: string
  • badgeInfo: BadgeInfo

BadgeStatus

Enum type:

  • "active"
  • "expired"
  • "expiredOld"
  • "failed"
  • "unknownKey"

BadgeType

Enum type:

  • "supporter"
  • "legend"
  • "investor"

BlockingInfo

Record type:

BlockingReason

Enum type:

  • "spam"
  • "content"

BrokerErrorType

Discriminated union type:

RESPONSE:

  • type: "RESPONSE"
  • respErr: string

UNEXPECTED:

  • type: "UNEXPECTED"
  • respErr: string

NETWORK:

HOST:

  • type: "HOST"

NO_SERVICE:

  • type: "NO_SERVICE"

TRANSPORT:

TIMEOUT:

  • type: "TIMEOUT"

BusinessChatInfo

Record type:

BusinessChatType

Enum type:

  • "business"
  • "customer"

CICallStatus

Enum type:

  • "pending"
  • "missed"
  • "rejected"
  • "accepted"
  • "negotiated"
  • "progress"
  • "ended"
  • "error"

CIContent

Discriminated union type:

SndMsgContent:

RcvMsgContent:

SndDeleted:

RcvDeleted:

SndCall:

RcvCall:

RcvIntegrityError:

RcvDecryptionError:

  • type: "rcvDecryptionError"
  • msgDecryptError: MsgDecryptError
  • msgCount: word32

RcvMsgError:

RcvGroupInvitation:

SndGroupInvitation:

RcvDirectEvent:

RcvGroupEvent:

SndGroupEvent:

RcvConnEvent:

SndConnEvent:

RcvChatFeature:

SndChatFeature:

RcvChatPreference:

SndChatPreference:

RcvGroupFeature:

SndGroupFeature:

RcvChatFeatureRejected:

RcvGroupFeatureRejected:

  • type: "rcvGroupFeatureRejected"
  • groupFeature: GroupFeature

SndModerated:

  • type: "sndModerated"

RcvModerated:

  • type: "rcvModerated"

RcvBlocked:

  • type: "rcvBlocked"

SndDirectE2EEInfo:

  • type: "sndDirectE2EEInfo"
  • e2eeInfo: E2EInfo

RcvDirectE2EEInfo:

  • type: "rcvDirectE2EEInfo"
  • e2eeInfo: E2EInfo

SndGroupE2EEInfo:

  • type: "sndGroupE2EEInfo"
  • e2eeInfo: E2EInfo

RcvGroupE2EEInfo:

  • type: "rcvGroupE2EEInfo"
  • e2eeInfo: E2EInfo

ChatBanner:

  • type: "chatBanner"

CIDeleteMode

Enum type:

  • "broadcast"
  • "internal"
  • "internalMark"
  • "history"

CIDeleted

Discriminated union type:

Deleted:

  • type: "deleted"
  • deletedTs: UTCTime?
  • chatType: ChatType

Blocked:

  • type: "blocked"
  • deletedTs: UTCTime?

BlockedByAdmin:

  • type: "blockedByAdmin"
  • deletedTs: UTCTime?

Moderated:

  • type: "moderated"
  • deletedTs: UTCTime?
  • byGroupMember: GroupMember

CIDirection

Discriminated union type:

DirectSnd:

  • type: "directSnd"

DirectRcv:

  • type: "directRcv"

GroupSnd:

  • type: "groupSnd"

GroupRcv:

ChannelRcv:

  • type: "channelRcv"

LocalSnd:

  • type: "localSnd"

LocalRcv:

  • type: "localRcv"

CIFile

Record type:

CIFileStatus

Discriminated union type:

SndStored:

  • type: "sndStored"

SndTransfer:

  • type: "sndTransfer"
  • sndProgress: int64
  • sndTotal: int64

SndCancelled:

  • type: "sndCancelled"

SndComplete:

  • type: "sndComplete"

SndError:

SndWarning:

RcvInvitation:

  • type: "rcvInvitation"

RcvAccepted:

  • type: "rcvAccepted"

RcvTransfer:

  • type: "rcvTransfer"
  • rcvProgress: int64
  • rcvTotal: int64

RcvAborted:

  • type: "rcvAborted"

RcvComplete:

  • type: "rcvComplete"

RcvCancelled:

  • type: "rcvCancelled"

RcvError:

RcvWarning:

Invalid:

  • type: "invalid"
  • text: string

CIForwardedFrom

Discriminated union type:

Unknown:

  • type: "unknown"

Contact:

  • type: "contact"
  • chatName: string
  • msgDir: MsgDirection
  • contactId: int64?
  • chatItemId: int64?

Group:

  • type: "group"
  • chatName: string
  • msgDir: MsgDirection
  • groupId: int64?
  • chatItemId: int64?

CIGroupInvitation

Record type:

CIGroupInvitationStatus

Enum type:

  • "pending"
  • "accepted"
  • "rejected"
  • "expired"

CIMention

Record type:

CIMentionMember

Record type:

  • groupMemberId: int64
  • displayName: string
  • localAlias: string?
  • memberRole: GroupMemberRole

CIMeta

Record type:

  • itemId: int64
  • itemTs: UTCTime
  • itemText: string
  • itemStatus: CIStatus
  • sentViaProxy: bool?
  • itemSharedMsgId: string?
  • itemForwarded: CIForwardedFrom?
  • itemDeleted: CIDeleted?
  • itemEdited: bool
  • itemTimed: CITimed?
  • itemLive: bool?
  • userMention: bool
  • hasLink: bool
  • deletable: bool
  • editable: bool
  • forwardedByMember: int64?
  • showGroupAsSender: bool
  • msgSigned: MsgSigStatus?
  • createdAt: UTCTime
  • updatedAt: UTCTime

CIQuote

Record type:

CIReaction

Record type:

CIReactionCount

Record type:

  • reaction: MsgReaction
  • userReacted: bool
  • totalReacted: int

CIStatus

Discriminated union type:

SndNew:

  • type: "sndNew"

SndSent:

SndRcvd:

SndErrorAuth:

  • type: "sndErrorAuth"

SndError:

SndWarning:

  • type: "sndWarning"
  • agentError: SndError

RcvNew:

  • type: "rcvNew"

RcvRead:

  • type: "rcvRead"

Invalid:

  • type: "invalid"
  • text: string

CITimed

Record type:

  • ttl: int
  • deleteAt: UTCTime?

ChatBotCommand

Discriminated union type:

Command:

  • type: "command"
  • keyword: string
  • label: string
  • params: string?

Menu:

ChatDeleteMode

Discriminated union type:

Full:

  • type: "full"
  • notify: bool

Entity:

  • type: "entity"
  • notify: bool

Messages:

  • type: "messages"

Syntax:

full|entity|messages[ notify=off]

type + (type == 'messages' ? '' : (!notify ? ' notify=off' : '')) // JavaScript

str(type) + ('' if str(type) == 'messages' else (' notify=off' if not notify else '')) # Python

ChatError

Discriminated union type:

Error:

ErrorAgent:

ErrorStore:

ChatErrorType

Discriminated union type:

NoActiveUser:

  • type: "noActiveUser"

NoConnectionUser:

  • type: "noConnectionUser"
  • agentConnId: string

NoSndFileUser:

  • type: "noSndFileUser"
  • agentSndFileId: string

NoRcvFileUser:

  • type: "noRcvFileUser"
  • agentRcvFileId: string

UserUnknown:

  • type: "userUnknown"

UserExists:

  • type: "userExists"
  • contactName: string

ChatRelayExists:

  • type: "chatRelayExists"

DifferentActiveUser:

  • type: "differentActiveUser"
  • commandUserId: int64
  • activeUserId: int64

CantDeleteActiveUser:

  • type: "cantDeleteActiveUser"
  • userId: int64

CantDeleteLastUser:

  • type: "cantDeleteLastUser"
  • userId: int64

CantHideLastUser:

  • type: "cantHideLastUser"
  • userId: int64

HiddenUserAlwaysMuted:

  • type: "hiddenUserAlwaysMuted"
  • userId: int64

EmptyUserPassword:

  • type: "emptyUserPassword"
  • userId: int64

UserAlreadyHidden:

  • type: "userAlreadyHidden"
  • userId: int64

UserNotHidden:

  • type: "userNotHidden"
  • userId: int64

InvalidDisplayName:

  • type: "invalidDisplayName"
  • displayName: string
  • validName: string

ChatNotStarted:

  • type: "chatNotStarted"

ChatNotStopped:

  • type: "chatNotStopped"

ChatStoreChanged:

  • type: "chatStoreChanged"

InvalidConnReq:

  • type: "invalidConnReq"

SimplexDomainNotReady:

UnsupportedConnReq:

  • type: "unsupportedConnReq"

ConnReqMessageProhibited:

  • type: "connReqMessageProhibited"

ContactNotReady:

  • type: "contactNotReady"
  • contact: Contact

ContactNotActive:

  • type: "contactNotActive"
  • contact: Contact

ContactDisabled:

  • type: "contactDisabled"
  • contact: Contact

ConnectionDisabled:

  • type: "connectionDisabled"
  • connection: Connection

GroupUserRole:

GroupMemberInitialRole:

ContactIncognitoCantInvite:

  • type: "contactIncognitoCantInvite"

GroupIncognitoCantInvite:

  • type: "groupIncognitoCantInvite"

GroupContactRole:

  • type: "groupContactRole"
  • contactName: string

GroupDuplicateMember:

  • type: "groupDuplicateMember"
  • contactName: string

GroupDuplicateMemberId:

  • type: "groupDuplicateMemberId"

GroupNotJoined:

  • type: "groupNotJoined"
  • groupInfo: GroupInfo

GroupMemberNotActive:

  • type: "groupMemberNotActive"

CantBlockMemberForSelf:

GroupMemberUserRemoved:

  • type: "groupMemberUserRemoved"

GroupMemberNotFound:

  • type: "groupMemberNotFound"

GroupCantResendInvitation:

  • type: "groupCantResendInvitation"
  • groupInfo: GroupInfo
  • contactName: string

GroupInternal:

  • type: "groupInternal"
  • message: string

FileNotFound:

  • type: "fileNotFound"
  • message: string

FileSize:

  • type: "fileSize"
  • filePath: string

FileAlreadyReceiving:

  • type: "fileAlreadyReceiving"
  • message: string

FileCancelled:

  • type: "fileCancelled"
  • message: string

FileCancel:

  • type: "fileCancel"
  • fileId: int64
  • message: string

FileAlreadyExists:

  • type: "fileAlreadyExists"
  • filePath: string

FileWrite:

  • type: "fileWrite"
  • filePath: string
  • message: string

FileSend:

FileRcvChunk:

  • type: "fileRcvChunk"
  • message: string

FileInternal:

  • type: "fileInternal"
  • message: string

FileImageType:

  • type: "fileImageType"
  • filePath: string

FileImageSize:

  • type: "fileImageSize"
  • filePath: string

FileNotReceived:

  • type: "fileNotReceived"
  • fileId: int64

FileNotApproved:

  • type: "fileNotApproved"
  • fileId: int64
  • unknownServers: [string]

FallbackToSMPProhibited:

  • type: "fallbackToSMPProhibited"
  • fileId: int64

InlineFileProhibited:

  • type: "inlineFileProhibited"
  • fileId: int64

InvalidForward:

  • type: "invalidForward"

InvalidChatItemUpdate:

  • type: "invalidChatItemUpdate"

InvalidChatItemDelete:

  • type: "invalidChatItemDelete"

HasCurrentCall:

  • type: "hasCurrentCall"

NoCurrentCall:

  • type: "noCurrentCall"

CallContact:

  • type: "callContact"
  • contactId: int64

DirectMessagesProhibited:

AgentVersion:

  • type: "agentVersion"

AgentNoSubResult:

  • type: "agentNoSubResult"
  • agentConnId: string

CommandError:

  • type: "commandError"
  • message: string

AgentCommandError:

  • type: "agentCommandError"
  • message: string

InvalidFileDescription:

  • type: "invalidFileDescription"
  • message: string

ConnectionIncognitoChangeProhibited:

  • type: "connectionIncognitoChangeProhibited"

ConnectionUserChangeProhibited:

  • type: "connectionUserChangeProhibited"

PeerChatVRangeIncompatible:

  • type: "peerChatVRangeIncompatible"

RelayTestError:

  • type: "relayTestError"
  • message: string

InternalError:

  • type: "internalError"
  • message: string

Exception:

  • type: "exception"
  • message: string

ChatFeature

Enum type:

  • "timedMessages"
  • "fullDelete"
  • "reactions"
  • "voice"
  • "files"
  • "calls"
  • "sessions"

ChatInfo

Discriminated union type:

Direct:

Group:

Local:

ContactRequest:

ContactConnection:

ChatItem

Record type:

ChatItemDeletion

Message deletion result.

Record type:

ChatListQuery

Discriminated union type:

Filters:

  • type: "filters"
  • favorite: bool
  • unread: bool

Search:

  • type: "search"
  • search: string

ChatPeerType

Enum type:

  • "human"
  • "bot"

ChatRef

Used in API commands. Chat scope can only be passed with groups.

Record type:

Syntax:

<str(chatType)><chatId>[<str(chatScope)>]

ChatType.cmdString(chatType) + chatId + (chatScope ? GroupChatScope.cmdString(chatScope) : '') // JavaScript

ChatType_cmd_string(chatType) + str(chatId) + ((GroupChatScope_cmd_string(chatScope)) if chatScope is not None else '') # Python

ChatSettings

Record type:

  • enableNtfs: MsgFilter
  • sendRcpts: bool?
  • favorite: bool

ChatStats

Record type:

  • unreadCount: int
  • unreadMentions: int
  • reportsCount: int
  • minUnreadItemId: int64
  • unreadChat: bool

ChatType

Enum type:

  • "direct"
  • "group"
  • "local"

Syntax:

@|#|*|

self == 'direct' ? '@' : self == 'group' ? '#' : self == 'local' ? '*' : '' // JavaScript

'@' if str(self) == 'direct' else '#' if str(self) == 'group' else '*' if str(self) == 'local' else '' # Python

ChatWallpaper

Record type:

  • preset: string?
  • imageFile: string?
  • background: string?
  • tint: string?
  • scaleType: ChatWallpaperScale?
  • scale: double?

ChatWallpaperScale

Enum type:

  • "fill"
  • "fit"
  • "repeat"

ClientNotice

Record type:

  • ttl: int64?

Color

Enum type:

  • "black"
  • "red"
  • "green"
  • "yellow"
  • "blue"
  • "magenta"
  • "cyan"
  • "white"

CommandError

Discriminated union type:

UNKNOWN:

  • type: "UNKNOWN"

SYNTAX:

  • type: "SYNTAX"

PROHIBITED:

  • type: "PROHIBITED"

NO_AUTH:

  • type: "NO_AUTH"

HAS_AUTH:

  • type: "HAS_AUTH"

NO_ENTITY:

  • type: "NO_ENTITY"

CommandErrorType

Discriminated union type:

PROHIBITED:

  • type: "PROHIBITED"

SYNTAX:

  • type: "SYNTAX"

NO_CONN:

  • type: "NO_CONN"

SIZE:

  • type: "SIZE"

LARGE:

  • type: "LARGE"

CommentsGroupPreference

Record type:

ComposedMessage

Record type:

ConnStatus

Discriminated union type:

New:

  • type: "new"

Prepared:

  • type: "prepared"

Joined:

  • type: "joined"

Requested:

  • type: "requested"

Accepted:

  • type: "accepted"

SndReady:

  • type: "sndReady"

Ready:

  • type: "ready"

Deleted:

  • type: "deleted"

Failed:

  • type: "failed"
  • connError: string

ConnType

Enum type:

  • "contact"
  • "member"
  • "user_contact"

Connection

Record type:

  • connId: int64
  • agentConnId: string
  • connChatVersion: int
  • peerChatVRange: VersionRange
  • connLevel: int
  • viaContact: int64?
  • viaUserContactLink: int64?
  • viaGroupLink: bool
  • groupLinkId: string?
  • xContactId: string?
  • customUserProfileId: int64?
  • connType: ConnType
  • connStatus: ConnStatus
  • contactConnInitiated: bool
  • localAlias: string
  • entityId: int64?
  • connectionCode: SecurityCode?
  • pqSupport: bool
  • pqEncryption: bool
  • pqSndEnabled: bool?
  • pqRcvEnabled: bool?
  • authErrCounter: int
  • quotaErrCounter: int
  • createdAt: UTCTime

ConnectionEntity

Discriminated union type:

RcvDirectMsgConnection:

RcvGroupMsgConnection:

UserContactConnection:

ConnectionErrorType

Discriminated union type:

NOT_FOUND:

  • type: "NOT_FOUND"

DUPLICATE:

  • type: "DUPLICATE"

SIMPLEX:

  • type: "SIMPLEX"

NOT_ACCEPTED:

  • type: "NOT_ACCEPTED"

NOT_AVAILABLE:

  • type: "NOT_AVAILABLE"

ConnectionMode

Enum type:

  • "inv"
  • "con"

ConnectionPlan

Discriminated union type:

InvitationLink:

ContactAddress:

GroupLink:

Error:

Contact

Record type:

ContactAddressPlan

Discriminated union type:

Ok:

OwnLink:

  • type: "ownLink"

ConnectingConfirmReconnect:

  • type: "connectingConfirmReconnect"

ConnectingProhibit:

  • type: "connectingProhibit"
  • contact: Contact

Known:

ContactViaAddress:

  • type: "contactViaAddress"
  • contact: Contact

ContactShortLinkData

Record type:

ContactStatus

Enum type:

  • "active"
  • "deleted"
  • "deletedByUser"

ContactUserPref

Discriminated union type:

Contact:

User:

ContactUserPreference

Record type:

ContactUserPreferences

Record type:

CreatedConnLink

Record type:

  • connFullLink: string
  • connShortLink: string?

Syntax:

<connFullLink>[ <connShortLink>]

connFullLink + (connShortLink ? ' ' + connShortLink : '') // JavaScript

connFullLink + ((' ' + connShortLink) if connShortLink is not None else '') # Python

CryptoFile

Record type:

CryptoFileArgs

Record type:

  • fileKey: string
  • fileNonce: string

DroppedMsg

Record type:

  • brokerTs: UTCTime
  • attempts: int

E2EInfo

Record type:

  • public: bool?
  • pqEnabled: bool?

ErrorType

Discriminated union type:

BLOCK:

  • type: "BLOCK"

SESSION:

  • type: "SESSION"

CMD:

PROXY:

AUTH:

  • type: "AUTH"

BLOCKED:

SERVICE:

  • type: "SERVICE"

CRYPTO:

  • type: "CRYPTO"

QUOTA:

  • type: "QUOTA"

STORE:

  • type: "STORE"
  • storeErr: string

NO_MSG:

  • type: "NO_MSG"

LARGE_MSG:

  • type: "LARGE_MSG"

EXPIRED:

  • type: "EXPIRED"

INTERNAL:

  • type: "INTERNAL"

NAME:

DUPLICATE_:

  • type: "DUPLICATE_"

FeatureAllowed

Enum type:

  • "always"
  • "yes"
  • "no"

FileDescr

Record type:

  • fileDescrText: string
  • fileDescrPartNo: int
  • fileDescrComplete: bool

FileError

Discriminated union type:

Auth:

  • type: "auth"

Blocked:

NoFile:

  • type: "noFile"

Relay:

Other:

  • type: "other"
  • fileError: string

FileErrorType

Discriminated union type:

NOT_APPROVED:

  • type: "NOT_APPROVED"

SIZE:

  • type: "SIZE"

REDIRECT:

  • type: "REDIRECT"
  • redirectError: string

FILE_IO:

  • type: "FILE_IO"
  • fileIOError: string

NO_FILE:

  • type: "NO_FILE"

FileInvitation

Record type:

  • fileName: string
  • fileSize: int64
  • fileDigest: string?
  • fileConnReq: string?
  • fileInline: InlineFileMode?
  • fileDescr: FileDescr?

FileProtocol

Enum type:

  • "smp"
  • "xftp"
  • "local"

FileStatus

Enum type:

  • "new"
  • "accepted"
  • "connected"
  • "complete"
  • "cancelled"

FileTransferMeta

Record type:

  • fileId: int64
  • xftpSndFile: XFTPSndFile?
  • xftpRedirectFor: int64?
  • fileName: string
  • filePath: string
  • fileSize: int64
  • fileInline: InlineFileMode?
  • chunkSize: int64
  • cancelled: bool

FileType

Enum type:

  • "normal"
  • "roster"

Format

Discriminated union type:

Bold:

  • type: "bold"

Italic:

  • type: "italic"

StrikeThrough:

  • type: "strikeThrough"

Snippet:

  • type: "snippet"

Secret:

  • type: "secret"

Small:

  • type: "small"

Colored:

  • type: "colored"
  • color: Color

Uri:

  • type: "uri"

HyperLink:

  • type: "hyperLink"
  • showText: string?
  • linkUri: string

SimplexLink:

  • type: "simplexLink"
  • showText: string?
  • linkType: SimplexLinkType
  • simplexUri: string
  • smpHosts: [string]

SimplexName:

Command:

  • type: "command"
  • commandStr: string

Mention:

  • type: "mention"
  • memberName: string

Email:

  • type: "email"

Phone:

  • type: "phone"

FormattedText

Record type:

  • format: Format?
  • text: string

FullGroupPreferences

Record type:

FullPreferences

Record type:

Group

Record type:

GroupChatScope

Discriminated union type:

MemberSupport:

  • type: "memberSupport"
  • groupMemberId_: int64?

Syntax:

(_support[:<groupMemberId_>])

'(_support' + (groupMemberId_ ? ':' + groupMemberId_ : '') + ')' // JavaScript

'(_support' + ((':' + str(groupMemberId_)) if groupMemberId_ is not None else '') + ')' # Python

GroupChatScopeInfo

Discriminated union type:

MemberSupport:

GroupDirectInvitation

Record type:

  • groupDirectInvLink: string
  • fromGroupId_: int64?
  • fromGroupMemberId_: int64?
  • fromGroupMemberConnId_: int64?
  • groupDirectInvStartedConnection: bool

GroupFeature

Enum type:

  • "timedMessages"
  • "directMessages"
  • "fullDelete"
  • "reactions"
  • "voice"
  • "files"
  • "simplexLinks"
  • "reports"
  • "history"
  • "support"
  • "sessions"
  • "comments"

GroupFeatureEnabled

Enum type:

  • "on"
  • "off"

GroupInfo

Record type:

GroupKeys

Record type:

  • publicGroupId: string
  • groupRootKey: GroupRootKey
  • memberPrivKey: string

GroupLink

Record type:

  • userContactLinkId: int64
  • connLinkContact: CreatedConnLink
  • shortLinkDataSet: bool
  • shortLinkLargeDataSet: bool
  • groupLinkId: string
  • acceptMemberRole: GroupMemberRole

GroupLinkOwner

Record type:

  • memberId: string
  • memberKey: string

GroupLinkPlan

Discriminated union type:

Ok:

OwnLink:

ConnectingConfirmReconnect:

  • type: "connectingConfirmReconnect"

ConnectingProhibit:

  • type: "connectingProhibit"
  • groupInfo_: GroupInfo?

Known:

NoRelays:

UpdateRequired:

GroupMember

Record type:

GroupMemberAdmission

Record type:

GroupMemberCategory

Enum type:

  • "user"
  • "invitee"
  • "host"
  • "pre"
  • "post"

GroupMemberRef

Record type:

  • groupMemberId: int64
  • profile: Profile

GroupMemberRole

Enum type:

  • "relay"
  • "observer"
  • "author"
  • "member"
  • "moderator"
  • "admin"
  • "owner"

GroupMemberSettings

Record type:

  • showMessages: bool

GroupMemberStatus

Enum type:

  • "rejected"
  • "removed"
  • "left"
  • "deleted"
  • "unknown"
  • "invited"
  • "pending_approval"
  • "pending_review"
  • "introduced"
  • "intro-inv"
  • "accepted"
  • "announced"
  • "connected"
  • "complete"
  • "creator"

GroupPreference

Record type:

GroupPreferences

Record type:

GroupProfile

Record type:

GroupRelay

Record type:

GroupRootKey

Discriminated union type:

Private:

  • type: "private"
  • rootPrivKey: string

Public:

  • type: "public"
  • rootPubKey: string

GroupShortLinkData

Record type:

GroupShortLinkInfo

Record type:

  • direct: bool
  • groupRelays: [string]
  • publicGroupId: string?

GroupSummary

Record type:

  • currentMembers: int64
  • publicMemberCount: int64?

GroupSupportChat

Record type:

  • chatTs: UTCTime
  • unread: int64
  • memberAttention: int64
  • mentions: int64
  • lastMsgFromMemberTs: UTCTime?

GroupType

Enum type:

  • "channel"
  • "group"

HandshakeError

Enum type:

  • "PARSE"
  • "IDENTITY"
  • "BAD_AUTH"
  • "BAD_SERVICE"

InlineFileMode

Enum type:

  • "offer"
  • "sent"

InvitationLinkPlan

Discriminated union type:

Ok:

OwnLink:

  • type: "ownLink"

Connecting:

  • type: "connecting"
  • contact_: Contact?

Known:

InvitedBy

Discriminated union type:

Contact:

  • type: "contact"
  • byContactId: int64

User:

  • type: "user"

Unknown:

  • type: "unknown"

LinkContent

Discriminated union type:

Page:

  • type: "page"

Image:

  • type: "image"

Video:

  • type: "video"
  • duration: int?

Unknown:

  • type: "unknown"
  • tag: string
  • json: JSONObject

LinkOwnerSig

Record type:

  • ownerId: string?
  • chatBinding: string
  • ownerSig: string

LinkPreview

Record type:

  • uri: string
  • title: string
  • description: string
  • image: string
  • content: LinkContent?

LocalBadge

Record type:

LocalProfile

Record type:

  • profileId: int64
  • displayName: string
  • fullName: string
  • shortDescr: string?
  • image: string?
  • contactLink: string?
  • preferences: Preferences?
  • peerType: ChatPeerType?
  • localBadge: LocalBadge?
  • localAlias: string
  • contactDomain: SimplexDomainClaim?
  • contactDomainVerified: bool?

MemberCriteria

Enum type:

  • "all"

MsgChatLink

Connection link sent in a message - only short links are allowed.

Discriminated union type:

Contact:

  • type: "contact"
  • connLink: string
  • profile: Profile
  • business: bool

Invitation:

  • type: "invitation"
  • invLink: string
  • profile: Profile

Group:

MsgContent

Discriminated union type:

Text:

  • type: "text"
  • text: string

Link:

Image:

  • type: "image"
  • text: string
  • image: string

Video:

  • type: "video"
  • text: string
  • image: string
  • duration: int

Voice:

  • type: "voice"
  • text: string
  • duration: int

File:

  • type: "file"
  • text: string

Report:

Chat:

Unknown:

  • type: "unknown"
  • tag: string
  • text: string
  • json: JSONObject

MsgDecryptError

Enum type:

  • "ratchetHeader"
  • "tooManySkipped"
  • "ratchetEarlier"
  • "other"
  • "ratchetSync"

MsgDirection

Enum type:

  • "rcv"
  • "snd"

MsgErrorType

Discriminated union type:

MsgSkipped:

  • type: "msgSkipped"
  • fromMsgId: int64
  • toMsgId: int64

MsgBadId:

  • type: "msgBadId"
  • msgId: int64

MsgBadHash:

  • type: "msgBadHash"

MsgDuplicate:

  • type: "msgDuplicate"

MsgFilter

Enum type:

  • "none"
  • "all"
  • "mentions"

MsgReaction

Discriminated union type:

Emoji:

  • type: "emoji"
  • emoji: string

Unknown:

  • type: "unknown"
  • tag: string
  • json: JSONObject

MsgReceiptStatus

Enum type:

  • "ok"
  • "badMsgHash"

MsgSigStatus

Enum type:

  • "verified"
  • "signedNoKey"

NameErrorType

Discriminated union type:

NO_RESOLVER:

  • type: "NO_RESOLVER"

NOT_FOUND:

  • type: "NOT_FOUND"

RESOLVER:

  • type: "RESOLVER"
  • resolverErr: string

NetworkError

Discriminated union type:

ConnectError:

  • type: "connectError"
  • connectError: string

TLSError:

  • type: "tLSError"
  • tlsError: string

UnknownCAError:

  • type: "unknownCAError"

FailedError:

  • type: "failedError"

TimeoutError:

  • type: "timeoutError"

SubscribeError:

  • type: "subscribeError"
  • subscribeError: string

NewUser

Record type:

  • profile: Profile?
  • pastTimestamp: bool
  • userChatRelay: bool
  • clientService: bool

NoteFolder

Record type:

  • noteFolderId: int64
  • userId: int64
  • createdAt: UTCTime
  • updatedAt: UTCTime
  • chatTs: UTCTime
  • favorite: bool
  • unread: bool

OwnerVerification

Discriminated union type:

Verified:

  • type: "verified"

Failed:

  • type: "failed"
  • reason: string

PaginationByTime

Discriminated union type:

Last:

  • type: "last"
  • count: int

Syntax:

count=<count>

'count=' + count // JavaScript

'count=' + str(count) # Python

PendingContactConnection

Record type:

  • pccConnId: int64
  • pccAgentConnId: string
  • pccConnStatus: ConnStatus
  • viaContactUri: bool
  • viaUserContactLink: int64?
  • groupLinkId: string?
  • customUserProfileId: int64?
  • connLinkInv: CreatedConnLink?
  • localAlias: string
  • createdAt: UTCTime
  • updatedAt: UTCTime

PrefEnabled

Record type:

  • forUser: bool
  • forContact: bool

Preferences

Record type:

PreparedContact

Record type:

PreparedGroup

Record type:

  • connLinkToConnect: CreatedConnLink
  • connLinkPreparedConnection: bool
  • connLinkStartedConnection: bool
  • welcomeSharedMsgId: string?
  • requestSharedMsgId: string?

Profile

Record type:

ProxyClientError

Discriminated union type:

ProtocolError:

  • type: "protocolError"
  • protocolErr: ErrorType

UnexpectedResponse:

  • type: "unexpectedResponse"
  • responseStr: string

ResponseError:

  • type: "responseError"
  • responseErr: ErrorType

ProxyError

Discriminated union type:

PROTOCOL:

BROKER:

BASIC_AUTH:

  • type: "BASIC_AUTH"

NO_SESSION:

  • type: "NO_SESSION"

PublicGroupAccess

Record type:

  • groupWebPage: string?
  • groupDomainClaim: SimplexDomainClaim?
  • domainWebPage: bool
  • allowEmbedding: bool

PublicGroupData

Record type:

  • publicMemberCount: int64

PublicGroupProfile

Record type:

RCErrorType

Discriminated union type:

Internal:

  • type: "internal"
  • internalErr: string

Identity:

  • type: "identity"

NoLocalAddress:

  • type: "noLocalAddress"

NewController:

  • type: "newController"

NotDiscovered:

  • type: "notDiscovered"

TLSStartFailed:

  • type: "tLSStartFailed"

Exception:

  • type: "exception"
  • exception: string

CtrlAuth:

  • type: "ctrlAuth"

CtrlNotFound:

  • type: "ctrlNotFound"

CtrlError:

  • type: "ctrlError"
  • ctrlErr: string

Invitation:

  • type: "invitation"

Version:

  • type: "version"

Encrypt:

  • type: "encrypt"

Decrypt:

  • type: "decrypt"

BlockSize:

  • type: "blockSize"

Syntax:

  • type: "syntax"
  • syntaxErr: string

RatchetSyncState

Enum type:

  • "ok"
  • "allowed"
  • "required"
  • "started"
  • "agreed"

RcvConnEvent

Discriminated union type:

SwitchQueue:

RatchetSync:

VerificationCodeReset:

  • type: "verificationCodeReset"

PqEnabled:

  • type: "pqEnabled"
  • enabled: bool

RcvDirectEvent

Discriminated union type:

ContactDeleted:

  • type: "contactDeleted"

ProfileUpdated:

GroupInvLinkReceived:

RcvFileDescr

Record type:

  • fileDescrId: int64
  • fileDescrText: string
  • fileDescrPartNo: int
  • fileDescrComplete: bool

RcvFileStatus

Discriminated union type:

New:

  • type: "new"

Accepted:

  • type: "accepted"
  • filePath: string

Connected:

  • type: "connected"
  • filePath: string

Complete:

  • type: "complete"
  • filePath: string

Cancelled:

  • type: "cancelled"
  • filePath_: string?

RcvFileTransfer

Record type:

RcvGroupEvent

Discriminated union type:

MemberAdded:

  • type: "memberAdded"
  • groupMemberId: int64
  • profile: Profile

MemberConnected:

  • type: "memberConnected"

MemberAccepted:

  • type: "memberAccepted"
  • groupMemberId: int64
  • profile: Profile

UserAccepted:

  • type: "userAccepted"

MemberLeft:

  • type: "memberLeft"

MemberRole:

MemberBlocked:

  • type: "memberBlocked"
  • groupMemberId: int64
  • profile: Profile
  • blocked: bool

UserRole:

MemberDeleted:

  • type: "memberDeleted"
  • groupMemberId: int64
  • profile: Profile

UserDeleted:

  • type: "userDeleted"

GroupDeleted:

  • type: "groupDeleted"

GroupUpdated:

InvitedViaGroupLink:

  • type: "invitedViaGroupLink"

MemberCreatedContact:

  • type: "memberCreatedContact"

MemberProfileUpdated:

  • type: "memberProfileUpdated"
  • fromProfile: Profile
  • toProfile: Profile

NewMemberPendingReview:

  • type: "newMemberPendingReview"

MsgBadSignature:

  • type: "msgBadSignature"

RcvMsgError

Discriminated union type:

Dropped:

  • type: "dropped"
  • attempts: int

ParseError:

  • type: "parseError"
  • parseError: string

RelayCapabilities

Record type:

  • webDomain: string?

RelayProfile

Record type:

  • displayName: string
  • fullName: string
  • shortDescr: string?
  • image: string?

RelayStatus

Enum type:

  • "new"
  • "invited"
  • "accepted"
  • "acknowledgedRoster"
  • "active"
  • "inactive"
  • "rejected"

ReportReason

Enum type:

  • "spam"
  • "content"
  • "community"
  • "profile"
  • "other"

RoleGroupPreference

Record type:

SMPAgentError

Discriminated union type:

A_MESSAGE:

  • type: "A_MESSAGE"

A_PROHIBITED:

  • type: "A_PROHIBITED"
  • prohibitedErr: string

A_VERSION:

  • type: "A_VERSION"

A_LINK:

  • type: "A_LINK"
  • linkErr: string

A_CRYPTO:

A_DUPLICATE:

A_QUEUE:

  • type: "A_QUEUE"
  • queueErr: string

SecurityCode

Record type:

  • securityCode: string
  • verifiedAt: UTCTime

SimplePreference

Record type:

SimplexDomain

Record type:

  • nameTLD: SimplexTLD
  • domain: string
  • subDomain: [string]

SimplexDomainClaim

Record type:

SimplexDomainError

Discriminated union type:

NoValidLink:

  • type: "noValidLink"

UnknownDomain:

  • type: "unknownDomain"

SimplexDomainProof

Record type:

  • linkOwnerId: string?
  • presHeader: string
  • signature: string

SimplexLinkType

Enum type:

  • "contact"
  • "invitation"
  • "group"
  • "channel"
  • "relay"

SimplexNameInfo

Record type:

SimplexNameType

Enum type:

  • "publicGroup"
  • "contact"

SimplexTLD

Enum type:

  • "simplex"
  • "testing"
  • "web"

SndCIStatusProgress

Enum type:

  • "partial"
  • "complete"

SndConnEvent

Discriminated union type:

SwitchQueue:

RatchetSync:

PqEnabled:

  • type: "pqEnabled"
  • enabled: bool

SndError

Discriminated union type:

Auth:

  • type: "auth"

Quota:

  • type: "quota"

Expired:

  • type: "expired"

Relay:

Proxy:

  • type: "proxy"
  • proxyServer: string
  • srvError: SrvError

ProxyRelay:

  • type: "proxyRelay"
  • proxyServer: string
  • srvError: SrvError

Other:

  • type: "other"
  • sndError: string

SndFileTransfer

Record type:

  • fileId: int64
  • fileName: string
  • filePath: string
  • fileSize: int64
  • chunkSize: int64
  • recipientDisplayName: string
  • connId: int64
  • agentConnId: string
  • groupMemberId: int64?
  • fileStatus: FileStatus
  • fileDescrId: int64?
  • fileInline: InlineFileMode?

SndGroupEvent

Discriminated union type:

MemberRole:

MemberBlocked:

  • type: "memberBlocked"
  • groupMemberId: int64
  • profile: Profile
  • blocked: bool

UserRole:

MemberDeleted:

  • type: "memberDeleted"
  • groupMemberId: int64
  • profile: Profile

UserLeft:

  • type: "userLeft"

GroupUpdated:

MemberAccepted:

  • type: "memberAccepted"
  • groupMemberId: int64
  • profile: Profile

UserPendingReview:

  • type: "userPendingReview"

SrvError

Discriminated union type:

Host:

  • type: "host"

Version:

  • type: "version"

Other:

  • type: "other"
  • srvError: string

StoreError

Discriminated union type:

DuplicateName:

  • type: "duplicateName"

UserNotFound:

  • type: "userNotFound"
  • userId: int64

RelayUserNotFound:

  • type: "relayUserNotFound"

UserNotFoundByName:

  • type: "userNotFoundByName"
  • contactName: string

UserNotFoundByContactId:

  • type: "userNotFoundByContactId"
  • contactId: int64

UserNotFoundByGroupId:

  • type: "userNotFoundByGroupId"
  • groupId: int64

UserNotFoundByFileId:

  • type: "userNotFoundByFileId"
  • fileId: int64

UserNotFoundByContactRequestId:

  • type: "userNotFoundByContactRequestId"
  • contactRequestId: int64

ContactNotFound:

  • type: "contactNotFound"
  • contactId: int64

ContactNotFoundByName:

  • type: "contactNotFoundByName"
  • contactName: string

ContactNotFoundByMemberId:

  • type: "contactNotFoundByMemberId"
  • groupMemberId: int64

ContactNotReady:

  • type: "contactNotReady"
  • contactName: string

DuplicateContactLink:

  • type: "duplicateContactLink"

UserContactLinkNotFound:

  • type: "userContactLinkNotFound"

ContactRequestNotFound:

  • type: "contactRequestNotFound"
  • contactRequestId: int64

ContactRequestNotFoundByName:

  • type: "contactRequestNotFoundByName"
  • contactName: string

InvalidContactRequestEntity:

  • type: "invalidContactRequestEntity"
  • contactRequestId: int64

InvalidBusinessChatContactRequest:

  • type: "invalidBusinessChatContactRequest"

GroupNotFound:

  • type: "groupNotFound"
  • groupId: int64

GroupNotFoundByName:

  • type: "groupNotFoundByName"
  • groupName: string

GroupMemberNameNotFound:

  • type: "groupMemberNameNotFound"
  • groupId: int64
  • groupMemberName: string

GroupMemberNotFound:

  • type: "groupMemberNotFound"
  • groupMemberId: int64

GroupMemberNotFoundByIndex:

  • type: "groupMemberNotFoundByIndex"
  • groupMemberIndex: int64

MemberRelationsVectorNotFound:

  • type: "memberRelationsVectorNotFound"
  • groupMemberId: int64

GroupHostMemberNotFound:

  • type: "groupHostMemberNotFound"
  • groupId: int64

GroupMemberNotFoundByMemberId:

  • type: "groupMemberNotFoundByMemberId"
  • memberId: string

MemberContactGroupMemberNotFound:

  • type: "memberContactGroupMemberNotFound"
  • contactId: int64

InvalidMemberRelationUpdate:

  • type: "invalidMemberRelationUpdate"

GroupWithoutUser:

  • type: "groupWithoutUser"

DuplicateGroupMember:

  • type: "duplicateGroupMember"

DuplicateMemberId:

  • type: "duplicateMemberId"

GroupAlreadyJoined:

  • type: "groupAlreadyJoined"

GroupInvitationNotFound:

  • type: "groupInvitationNotFound"

NoteFolderAlreadyExists:

  • type: "noteFolderAlreadyExists"
  • noteFolderId: int64

NoteFolderNotFound:

  • type: "noteFolderNotFound"
  • noteFolderId: int64

UserNoteFolderNotFound:

  • type: "userNoteFolderNotFound"

SndFileNotFound:

  • type: "sndFileNotFound"
  • fileId: int64

SndFileInvalid:

  • type: "sndFileInvalid"
  • fileId: int64

RcvFileNotFound:

  • type: "rcvFileNotFound"
  • fileId: int64

RcvFileDescrNotFound:

  • type: "rcvFileDescrNotFound"
  • fileId: int64

FileNotFound:

  • type: "fileNotFound"
  • fileId: int64

RcvFileInvalid:

  • type: "rcvFileInvalid"
  • fileId: int64

RcvFileInvalidDescrPart:

  • type: "rcvFileInvalidDescrPart"

LocalFileNoTransfer:

  • type: "localFileNoTransfer"
  • fileId: int64

SharedMsgIdNotFoundByFileId:

  • type: "sharedMsgIdNotFoundByFileId"
  • fileId: int64

FileIdNotFoundBySharedMsgId:

  • type: "fileIdNotFoundBySharedMsgId"
  • sharedMsgId: string

SndFileNotFoundXFTP:

  • type: "sndFileNotFoundXFTP"
  • agentSndFileId: string

RcvFileNotFoundXFTP:

  • type: "rcvFileNotFoundXFTP"
  • agentRcvFileId: string

ConnectionNotFound:

  • type: "connectionNotFound"
  • agentConnId: string

ConnectionNotFoundById:

  • type: "connectionNotFoundById"
  • connId: int64

ConnectionNotFoundByMemberId:

  • type: "connectionNotFoundByMemberId"
  • groupMemberId: int64

PendingConnectionNotFound:

  • type: "pendingConnectionNotFound"
  • connId: int64

UniqueID:

  • type: "uniqueID"

LargeMsg:

  • type: "largeMsg"

InternalError:

  • type: "internalError"
  • message: string

DBException:

  • type: "dBException"
  • message: string

DBBusyError:

  • type: "dBBusyError"
  • message: string

BadChatItem:

  • type: "badChatItem"
  • itemId: int64
  • itemTs: UTCTime?

ChatItemNotFound:

  • type: "chatItemNotFound"
  • itemId: int64

ChatItemNotFoundByText:

  • type: "chatItemNotFoundByText"
  • text: string

ChatItemSharedMsgIdNotFound:

  • type: "chatItemSharedMsgIdNotFound"
  • sharedMsgId: string

ChatItemNotFoundByFileId:

  • type: "chatItemNotFoundByFileId"
  • fileId: int64

ChatItemNotFoundByContactId:

  • type: "chatItemNotFoundByContactId"
  • contactId: int64

ChatItemNotFoundByGroupId:

  • type: "chatItemNotFoundByGroupId"
  • groupId: int64

ProfileNotFound:

  • type: "profileNotFound"
  • profileId: int64

DuplicateGroupLink:

  • type: "duplicateGroupLink"
  • groupInfo: GroupInfo

GroupLinkNotFound:

  • type: "groupLinkNotFound"
  • groupInfo: GroupInfo

HostMemberIdNotFound:

  • type: "hostMemberIdNotFound"
  • groupId: int64

ContactNotFoundByFileId:

  • type: "contactNotFoundByFileId"
  • fileId: int64

NoGroupSndStatus:

  • type: "noGroupSndStatus"
  • itemId: int64
  • groupMemberId: int64

DuplicateGroupMessage:

  • type: "duplicateGroupMessage"
  • groupId: int64
  • sharedMsgId: string
  • authorGroupMemberId: int64?
  • forwardedByGroupMemberId: int64?

RemoteHostNotFound:

  • type: "remoteHostNotFound"
  • remoteHostId: int64

RemoteHostUnknown:

  • type: "remoteHostUnknown"

RemoteHostDuplicateCA:

  • type: "remoteHostDuplicateCA"

RemoteCtrlNotFound:

  • type: "remoteCtrlNotFound"
  • remoteCtrlId: int64

RemoteCtrlDuplicateCA:

  • type: "remoteCtrlDuplicateCA"

ProhibitedDeleteUser:

  • type: "prohibitedDeleteUser"
  • userId: int64
  • contactId: int64

OperatorNotFound:

  • type: "operatorNotFound"
  • serverOperatorId: int64

UsageConditionsNotFound:

  • type: "usageConditionsNotFound"

UserChatRelayNotFound:

  • type: "userChatRelayNotFound"
  • chatRelayId: int64

GroupRelayNotFound:

  • type: "groupRelayNotFound"
  • groupRelayId: int64

GroupRelayNotFoundByMemberId:

  • type: "groupRelayNotFoundByMemberId"
  • groupMemberId: int64

InvalidQuote:

  • type: "invalidQuote"

InvalidMention:

  • type: "invalidMention"

InvalidDeliveryTask:

  • type: "invalidDeliveryTask"
  • taskId: int64

DeliveryTaskNotFound:

  • type: "deliveryTaskNotFound"
  • taskId: int64

InvalidDeliveryJob:

  • type: "invalidDeliveryJob"
  • jobId: int64

DeliveryJobNotFound:

  • type: "deliveryJobNotFound"
  • jobId: int64

WorkItemError:

  • type: "workItemError"
  • errContext: string

SubscriptionStatus

Discriminated union type:

Active:

  • type: "active"

Pending:

  • type: "pending"

Removed:

  • type: "removed"
  • subError: string

NoSub:

  • type: "noSub"

SupportGroupPreference

Record type:

SwitchPhase

Enum type:

  • "started"
  • "confirmed"
  • "secured"
  • "completed"

TimedMessagesGroupPreference

Record type:

TimedMessagesPreference

Record type:

TransportError

Discriminated union type:

BadBlock:

  • type: "badBlock"

Version:

  • type: "version"

LargeMsg:

  • type: "largeMsg"

BadSession:

  • type: "badSession"

NoServerAuth:

  • type: "noServerAuth"

Handshake:

UIColorMode

Enum type:

  • "light"
  • "dark"

UIColors

Record type:

  • accent: string?
  • accentVariant: string?
  • secondary: string?
  • secondaryVariant: string?
  • background: string?
  • menus: string?
  • title: string?
  • accentVariant2: string?
  • sentMessage: string?
  • sentReply: string?
  • receivedMessage: string?
  • receivedReply: string?

UIThemeEntityOverride

Record type:

UIThemeEntityOverrides

Record type:

UpdatedMessage

Record type:

  • msgContent: MsgContent
  • mentions: {string : int64}

User

Record type:

  • userId: int64
  • agentUserId: int64
  • userContactId: int64
  • localDisplayName: string
  • profile: LocalProfile
  • fullPreferences: FullPreferences
  • activeUser: bool
  • activeOrder: int64
  • viewPwdHash: UserPwdHash?
  • showNtfs: bool
  • sendRcptsContacts: bool
  • sendRcptsSmallGroups: bool
  • autoAcceptMemberContacts: bool
  • userMemberProfileUpdatedAt: UTCTime?
  • userChatRelay: bool
  • clientService: bool
  • uiThemes: UIThemeEntityOverrides?

UserChatRelay

Record type:

  • chatRelayId: int64
  • address: string
  • relayProfile: RelayProfile
  • domains: [string]
  • preset: bool
  • tested: bool?
  • enabled: bool
  • deleted: bool

UserContact

Record type:

  • userContactLinkId: int64
  • connReqContact: string
  • groupId: int64?

UserContactLink

Record type:

UserContactRequest

Record type:

  • contactRequestId: int64
  • agentInvitationId: string
  • contactId_: int64?
  • businessGroupId_: int64?
  • userContactLinkId_: int64?
  • cReqChatVRange: VersionRange
  • localDisplayName: string
  • profileId: int64
  • profile: LocalProfile
  • createdAt: UTCTime
  • updatedAt: UTCTime
  • xContactId: string?
  • pqSupport: bool
  • welcomeSharedMsgId: string?
  • requestSharedMsgId: string?

UserInfo

Record type:

  • user: User
  • unreadCount: int

UserProfileUpdateSummary

Record type:

  • updateSuccesses: int
  • updateFailures: int
  • changedContacts: [Contact]

UserPwdHash

Record type:

  • hash: string
  • salt: string

VersionRange

Record type:

  • minVersion: int
  • maxVersion: int

XFTPErrorType

Discriminated union type:

BLOCK:

  • type: "BLOCK"

SESSION:

  • type: "SESSION"

HANDSHAKE:

  • type: "HANDSHAKE"

CMD:

AUTH:

  • type: "AUTH"

BLOCKED:

SIZE:

  • type: "SIZE"

QUOTA:

  • type: "QUOTA"

DIGEST:

  • type: "DIGEST"

CRYPTO:

  • type: "CRYPTO"

NO_FILE:

  • type: "NO_FILE"

HAS_FILE:

  • type: "HAS_FILE"

FILE_IO:

  • type: "FILE_IO"

TIMEOUT:

  • type: "TIMEOUT"

INTERNAL:

  • type: "INTERNAL"

DUPLICATE_:

  • type: "DUPLICATE_"

XFTPRcvFile

Record type:

  • rcvFileDescription: RcvFileDescr
  • agentRcvFileId: string?
  • agentRcvFileDeleted: bool
  • userApprovedRelays: bool

XFTPSndFile

Record type:

  • agentSndFileId: string
  • privateSndFileDescr: string?
  • agentSndFileDeleted: bool
  • cryptoArgs: CryptoFileArgs?
Reference in New Issue View Git Blame Copy Permalink