Users services

C# signatures use the types and conventions in Integration. CancellationToken controls the client call. Command objects include inherited fields from ApiCommand where applicable.

IAccounts

Read accounts, manage the caller's profile and sessions, and create API keys. Source

Task OnSignOut(
    Accounts_SignOut command,
    CancellationToken cancellationToken
);

Task OnUpdate(
    Accounts_Update command,
    CancellationToken cancellationToken
);

Task OnDeleteOwn(
    Accounts_DeleteOwn command,
    CancellationToken cancellationToken
);

Task<string> OnCreateApiKey(
    Accounts_CreateApiKey command,
    CancellationToken cancellationToken
);

Task OnDeactivateSession(
    Accounts_DeactivateSession command,
    CancellationToken cancellationToken
);

Task OnDeactivateAllSessions(
    Accounts_DeactivateAllSessions command,
    CancellationToken cancellationToken
);

Task OnConfirmRegister(
    Accounts_ConfirmRegister command,
    CancellationToken cancellationToken
);

Task OnCancelRegister(
    Accounts_CancelRegister command,
    CancellationToken cancellationToken
);

Task<AccountFull> GetOwn(
    Session session,
    CancellationToken cancellationToken
);

Task<Account?> Get(
    Session session,
    UserId userId,
    CancellationToken cancellationToken
);

Task<AccountFull?> GetFull(
    Session session,
    UserId userId,
    CancellationToken cancellationToken
);

Task<SessionInfoFull?> GetSessionInfo(
    Session session,
    CancellationToken cancellationToken
);

Task<ApiList<SessionInfo>> ListOwnSessions(
    Session session,
    SessionKind kind,
    CancellationToken cancellationToken
);

Related data: Account, AccountFull, Accounts_CancelRegister, Accounts_ConfirmRegister, Accounts_CreateApiKey, Accounts_DeactivateAllSessions, Accounts_DeactivateSession, Accounts_DeleteOwn, Accounts_SignOut, Accounts_Update, SessionInfo, SessionInfoFull, SessionKind, UserId.

IAppUpdates

Read the latest application update for a target platform. Source

Registered on API hosts. AppUpdateInfo now lives in the ActualChat.Api package.

Task<AppUpdateInfo?> GetLatestUpdateInfo(
    AppKind appKind,
    CancellationToken cancellationToken
);

Related data: AppKind, AppUpdateInfo.

IAvatars

Manage the caller's avatars and select the default avatar. Source

Task<AvatarFull?> GetOwn(
    Session session,
    Symbol avatarId,
    CancellationToken cancellationToken
);

Task<Avatar?> Get(
    Session session,
    Symbol avatarId,
    CancellationToken cancellationToken
);

Task<IReadOnlyList<Symbol>> ListOwnAvatarIds(
    Session session,
    CancellationToken cancellationToken
);

Task<AvatarFull> OnChange(
    Avatars_Change command,
    CancellationToken cancellationToken
);

Task OnSetDefault(
    Avatars_SetDefault command,
    CancellationToken cancellationToken
);

Related data: Avatar, AvatarFull, Avatars_Change, Avatars_SetDefault.

ICaptcha

Validate reCAPTCHA tokens for a specified action. Source

Task<RecaptchaValidationResult> Validate(
    string token,
    string action,
    CancellationToken cancellationToken
);

Related data: RecaptchaValidationResult.

IChatPositions

Read and update the caller's per-chat read/view positions. Source

Task<ChatPosition> GetOwn(
    Session session,
    ChatId chatId,
    ChatPositionKind kind,
    CancellationToken cancellationToken
);

Task OnSet(
    ChatPositions_Set command,
    CancellationToken cancellationToken
);

Related data: ChatId, ChatPosition, ChatPositionKind, ChatPositions_Set.

IChatUsages

Read recent chat usage and register usage. Source

Task<ChatId[]> GetRecencyList(
    Session session,
    ChatUsageListKind kind,
    CancellationToken cancellationToken
);

Task OnRegisterUsage(
    ChatUsages_RegisterUsage command,
    CancellationToken cancellationToken
);

Related data: ChatId, ChatUsageListKind, ChatUsages_RegisterUsage.

IEmailAuth

Request and validate email authentication and verification codes. Source

Task<string> GetEmailValidationMessage(
    Session session,
    Email email,
    TotpPurpose purpose,
    CancellationToken cancellationToken
);

Task<bool> AccountExists(
    Session session,
    Email email,
    CancellationToken cancellationToken
);

Task<Moment> OnSendTotp(
    EmailAuth_SendTotp command,
    CancellationToken cancellationToken
);

Task<bool> OnValidateTotp(
    EmailAuth_ValidateTotp command,
    CancellationToken cancellationToken
);

Task<bool> OnVerifyEmail(
    EmailAuth_VerifyEmail command,
    CancellationToken cancellationToken
);

Task<string> CheckIfBlocked(
    Session session,
    Email email,
    TotpPurpose purpose,
    CancellationToken cancellationToken
);

Related data: Email, EmailAuth_SendTotp, EmailAuth_ValidateTotp, EmailAuth_VerifyEmail, TotpPurpose.

IEmails

Preview and send email digests; availability depends on server policy. Source

Task<DigestPreview> GetDigestPreview(
    Session session,
    ChatId[] chatIds,
    DateTime? asOf,
    CancellationToken cancellationToken
);

Task OnSendDigest(
    Emails_SendDigest command,
    CancellationToken cancellationToken
);

Related data: ChatId, DigestPreview, Emails_SendDigest.

IMobileSessions

Create and validate native-client sessions. Source

Task<Session> CreateSession(
    string appUserAgent,
    CancellationToken cancellationToken
);

Task<Session> ValidateSession(
    Session session,
    string appUserAgent,
    CancellationToken cancellationToken
);

Related data: .

INativeAuth

Complete native Google/Apple authentication and sign-out. Source

Registered only where the server has ASP.NET authentication configuration.

Task OnSignInGoogle(
    NativeAuth_SignInGoogle command,
    CancellationToken cancellationToken
);

Task OnSignInApple(
    NativeAuth_SignInApple command,
    CancellationToken cancellationToken
);

Task OnSignOut(
    NativeAuth_SignOut command,
    CancellationToken cancellationToken
);

Related data: NativeAuth_SignInApple, NativeAuth_SignInGoogle, NativeAuth_SignOut.

IPhoneAuth

Request and validate phone authentication and verification codes. Source

Task<bool> IsEnabled(CancellationToken cancellationToken);

Task<string> CheckIfBlocked(
    Session session,
    Phone phone,
    TotpPurpose purpose,
    CancellationToken cancellationToken
);

Task<bool> AccountExists(
    Session session,
    Phone phone,
    CancellationToken cancellationToken
);

Task<TotpSendResult> OnSendCode(
    PhoneAuth_SendCode command,
    CancellationToken cancellationToken
);

Task<Moment> OnSendTotp(
    PhoneAuth_SendTotp command,
    CancellationToken cancellationToken
);

Task<bool> OnValidateTotp(
    PhoneAuth_ValidateTotp command,
    CancellationToken cancellationToken
);

Task<bool> OnVerifyPhone(
    PhoneAuth_VerifyPhone command,
    CancellationToken cancellationToken
);

Related data: Phone, PhoneAuth_SendCode, PhoneAuth_SendTotp, PhoneAuth_ValidateTotp, PhoneAuth_VerifyPhone, TotpPurpose, TotpSendResult.

IPhones

Parse phone numbers and apply account-country defaults. Source

Task<Phone?> Parse(
    string phone,
    CancellationToken cancellationToken
);

Task<Phone?> ParseWithCountryFallback(
    Session session,
    string phone,
    CancellationToken cancellationToken
);

Task<Phone?> GetExampleCountryPhone(
    Session session,
    CancellationToken cancellationToken
);

Related data: Phone.

ISessionTemporals

Read and write temporary session-scoped strings. Source

Task<string?> Get(
    Session session,
    string key,
    CancellationToken cancellationToken
);

Task OnSet(
    SessionTemporals_Set command,
    CancellationToken cancellationToken
);

Related data: SessionTemporals_Set.

ISystemProperties

Read server time and API compatibility; perform network probes and privileged maintenance. Source

GetServerApiInfo and GetServerApiInfoNC return compatibility and version strings. Maintenance commands are not ordinary application integration operations. GetProbePayloadLegacy is the wire name GetProbePayload for v2.21 and older clients; newer clients use IRpcChecks.GetPayload.

Task<double> GetTime(CancellationToken cancellationToken);

Task<byte[]> GetProbePayloadLegacy(
    int size,
    CancellationToken cancellationToken
);

Task ReportRpcEndpoint(
    RpcEndpointReport report,
    CancellationToken cancellationToken
);

Task<ServerApiInfo> GetServerApiInfo(
    string expectedVersion,
    CancellationToken cancellationToken
);

Task<ServerApiInfo> GetServerApiInfoNC(
    string expectedVersion,
    CancellationToken cancellationToken
);

Task OnInvalidateEverything(
    SystemProperties_InvalidateEverything command,
    CancellationToken cancellationToken
);

Task OnPruneComputedGraph(
    SystemProperties_PruneComputedGraph command,
    CancellationToken cancellationToken
);

Related data: RpcEndpointReport, ServerApiInfo, SystemProperties_InvalidateEverything, SystemProperties_PruneComputedGraph.

ITimeZones

List localized time zones and convert Windows IDs to IANA names. Source

Task<TimeZone[]> List(
    string languageCode,
    CancellationToken cancellationToken
);

Task<string> ConvertWindowsToIana(
    string windowsTimeZone,
    CancellationToken cancellationToken
);

Task<string> FindDisplayName(
    string languageCode,
    string timeZoneId,
    CancellationToken cancellationToken
);

Related data: TimeZone.

IUserPresences

Read presence and last check-in and report the caller's activity. Source

Task<Presence> Get(
    UserId userId,
    CancellationToken cancellationToken
);

Task<ApiNullable8<Moment>> GetLastCheckIn(
    UserId userId,
    CancellationToken cancellationToken
);

Task OnCheckIn(
    UserPresences_CheckIn command,
    CancellationToken cancellationToken
);

Related data: Presence, UserId, UserPresences_CheckIn.