AddressBooks

inner class AddressBooks

Address-book operations. Reached via books.

Functions

Link copied to clipboard
suspend fun create(webId: String, title: String, isPrivate: Boolean = true, storage: String? = null, container: String? = null): AddressBook?

Creates an address book titled title.

Link copied to clipboard
suspend fun delete(webId: String, addressBookUri: String): AddressBook?

Deletes the address book at addressBookUri and everything in it.

Link copied to clipboard
suspend fun ensureContainer(webId: String, storage: String? = null, container: String? = null): AddressBookList?

Bootstraps the address-book container if absent, then returns the books in it.

Link copied to clipboard
suspend fun ensureDefault(webId: String, storage: String? = null, title: String = "Contacts"): AddressBook?

Returns the user's default address book, creating it (titled title) if absent.

Link copied to clipboard
suspend fun get(webId: String, addressBookUri: String): AddressBook?

Reads the address book at addressBookUri.

Link copied to clipboard
suspend fun list(webId: String): AddressBookList?

Returns every address book that belongs to webId.

Link copied to clipboard
suspend fun rename(webId: String, addressBookUri: String, newName: String): AddressBook?

Renames the address book at addressBookUri.