ContactService class base

app.bsky.contact.*

Constructors

ContactService(ServiceContext ctx)

Properties

ctx → ServiceContext

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

dismissMatch({required String subject, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<EmptyData>>

Removes a match that was found via contact import. It shouldn't appear again if the same contact is re-imported. Requires authentication.

getMatches({int? limit, String? cursor, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<ContactGetMatchesOutput>>

Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.

getSyncStatus({String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<ContactGetSyncStatusOutput>>

Gets the user's current contact import status. Requires authentication.

importContacts({required String token, required List<String> contacts, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<ContactImportContactsOutput>>

Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeData({String? $service, Map<String, String>? $headers}) → Future<XRPCResponse<EmptyData>>

Removes all stored hashes used for contact matching, existing matches, and sync status. Requires authentication.

sendNotification({required String from, required String to, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<EmptyData>>

System endpoint to send notifications related to contact imports. Requires role authentication.

startPhoneVerification({required String phone, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<EmptyData>>

Starts a phone verification flow. The phone passed will receive a code via SMS that should be passed to app.bsky.contact.verifyPhone. Requires authentication.

toString() → String

A string representation of this object.

inherited

verifyPhone({required String phone, required String code, String? $service, Map<String, String>? $headers, Map<String, String>? $unknown}) → Future<XRPCResponse<ContactVerifyPhoneOutput>>

Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.

Operators

operator ==(Object other) → bool

The equality operator.

inherited