Libsoftphone/cz.acrobits.libsoftphone/Instance/Contacts

Contacts

class Contacts

Methods for contacts.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
class NumberRewriting
Methods for number rewriting.
Link copied to clipboard
class Smart
Methods for smart contacts.

Functions

Link copied to clipboard
open fun ensureValidState(@NonNull source: ContactSourceType)
Ensure contacts information is up-to-date with the given contact source.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun get(@NonNull id: ContactId): Json.Dict
Get contact from the giver contact ID
@CheckResult
@MainThread
@NonNull
open fun get(@NonNull source: ContactSourceType, @IntRange(from = 0) index: Int): Json.Dict
Get contact from the given source,
@CheckResult
@MainThread
@Nullable
open fun get(@NonNull source: ContactSourceType, @NonNull id: String): Json.Dict
Get contact from the given contact source
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getAvatarLarge(@NonNull contactId: ContactId): AssetRequest
Get the avatar of a contact in the given source.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getAvatarThumb(@NonNull contactId: ContactId): AssetRequest
Get the thumbnail of avatar of a contact in the given source.
Link copied to clipboard
@CheckResult
@MainThread
@IntRange(from = 0)
open fun getBlockBitCount(@NonNull source: ContactSourceType): Int
Return how many bits are used to identify contact blocks in the given source When n bits are used, the internal storage has contacts divided into 2ⁿ blocks.
Link copied to clipboard
open fun getContactSourceState(@NonNull source: ContactSourceType): ContactSourceState
Whether the contacts are being loaded.
Link copied to clipboard
@CheckResult
@MainThread
open fun getCount(@NonNull source: ContactSourceType): Int
Get number of contacts in a given contact source.
@CheckResult
@MainThread
open fun getCount(@NonNull source: ContactSourceType, @Nullable query: ContactQuery): Int
Get number of contacts for a query in a given contact source.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getSections(@NonNull source: ContactSourceType): Array<ContactSection>
@CheckResult
@MainThread
@NonNull
open fun getSections(@NonNull source: ContactSourceType, @NonNull ids: Set<String>): Array<ContactSection>
Get sections for full alphabetical sequence of contacts from the given source.
@CheckResult
@MainThread
@NonNull
open fun getSections(@NonNull source: ContactSourceType, @NonNull query: ContactQuery): Array<ContactSection>
Get sections for full alphabetical sequence of contacts from the given source
Link copied to clipboard
@NonNull
open fun getSources(): Array<ContactSourceType>
Get all the sources which are configured and valid.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getStorageChecksum(@NonNull source: ContactSourceType): String
Get checksum of all contacts from the given source in storage.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType, @IntRange(from = 0) from: Int): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType, @IntRange(from = 0) from: Int, @IntRange(from = "-1") limit: Int): ContactIterator
Iterate contacts from the given source in alphabetical order.
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType, @NonNull query: ContactQuery): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType, @NonNull query: ContactQuery, @IntRange(from = 0) from: Int): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateAlphabetically(@NonNull source: ContactSourceType, @NonNull query: ContactQuery, @IntRange(from = 0) from: Int, @IntRange(from = "-1") limit: Int): ContactIterator
Iterate a set of contacts from the given source in alphabetical order.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun iterateUnordered(@NonNull source: ContactSourceType): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateUnordered(@NonNull source: ContactSourceType, @IntRange(from = 0) from: Int): ContactIterator
@CheckResult
@MainThread
@NonNull
open fun iterateUnordered(@NonNull source: ContactSourceType, @IntRange(from = 0) from: Int, @IntRange(from = "-1") limit: Int): ContactIterator
Iterate contacts from the given source without any specific order.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun search(@NonNull query: IndexQuery): Array<IndexMatch>
@CheckResult
@MainThread
@NonNull
open fun search(@NonNull query: IndexQuery, @IntRange(from = 0) limit: Int): Array<IndexMatch>
@CheckResult
@MainThread
@NonNull
open fun search(@NonNull query: IndexQuery, @IntRange(from = 0) limit: Int, resolveSpans: Boolean): Array<IndexMatch>
Perform a full-text search in contact storage.
@CheckResult
@MainThread
@NonNull
open fun search(@NonNull query: IndexQuery, resolveSpans: Boolean): Array<IndexMatch>
@CheckResult
@MainThread
@NonNull
open fun search(@NonNull query: IndexQuery, @IntRange(from = 0) limit: Int, resolveSpans: Boolean, @Nullable searchText: String): Array<IndexMatch>
Link copied to clipboard
@MainThread
open fun setAuxiliary(@NonNull source: ContactSourceType, @NonNull id: String, @Nullable auxiliary: Json.Dict): Boolean
Set auxiliary data to a contact in the given source The stored JSON dictionary is accessible under key AUXILIARY.
Generated by Dokka
© 2026 Copyright