Interface ContactsModule

interface ContactsModule {
    addContactToGroup(command): Promise<void>;
    addNewEmailAddress(command): Promise<string>;
    addNewPhoneNumber(command): Promise<string>;
    createAddressBook(command): Promise<string>;
    createNewContact(command): Promise<string>;
    createNewGroup(command): Promise<string>;
    listAddressBooks(webId): Promise<AddressBookLists>;
    readAddressBook(uri): Promise<AddressBook>;
    readContact(uri): Promise<FullContact>;
    readGroup(uri): Promise<FullGroup>;
    removeContactFromGroup(command): Promise<void>;
    removeEmailAddress(command): Promise<void>;
    removePhoneNumber(command): Promise<void>;
    renameContact(command): Promise<void>;
}

Implemented by

Methods

addContactToGroup addNewEmailAddress addNewPhoneNumber createAddressBook createNewContact createNewGroup listAddressBooks readAddressBook readContact readGroup removeContactFromGroup removeEmailAddress removePhoneNumber renameContact

Methods

addContactToGroup

addNewEmailAddress

  • addNewEmailAddress(command): Promise<string>

  • Adds a new email address to the given contact

    Parameters

    Returns Promise<string>

    The URI of the newly created email address resource

addNewPhoneNumber

  • addNewPhoneNumber(command): Promise<string>

  • Adds a new phone number to the given contact

    Parameters

    Returns Promise<string>

    The URI of the newly created phone number resource

createAddressBook

  • createAddressBook(command): Promise<string>

  • Creates a new address book in the given container

    Parameters

    Returns Promise<string>

    The URI of the newly created address book

createNewContact

  • createNewContact(command): Promise<string>

  • Creates a new contact within a given address book

    Parameters

    Returns Promise<string>

    The URI of the newly created contact

createNewGroup

  • createNewGroup(command): Promise<string>

  • Creates a new group within a given address book

    Parameters

    Returns Promise<string>

    The URI of the newly created group

listAddressBooks

  • listAddressBooks(webId): Promise<AddressBookLists>

  • Lists all known address books of the given Solid user. Private instances will only be listed, if the fetcher has access to the preferences document and the private type index, otherwise only public instances will be returned and the privateUris will be an empty array.

    Parameters

    • webId: string

      The WebID of the user whose address books to list

    Returns Promise<AddressBookLists>

    The URIs of the address books grouped by public (listed) and private (unlisted) instances

readAddressBook

  • readAddressBook(uri): Promise<AddressBook>

  • Fetch the index data of address book identified by the given URI

    Parameters

    • uri: string

      The URI of the address book to read

    Returns Promise<AddressBook>

    The address book title and all known people and groups in that address book

readContact

  • readContact(uri): Promise<FullContact>

  • Fetches the given contact and returns available information

    Parameters

    • uri: string

      The URI of the contact to read

    Returns Promise<FullContact>

    FullContact name, email addresses and phone numbers

readGroup

  • readGroup(uri): Promise<FullGroup>

  • Fetches the given group and returns available information

    Parameters

    • uri: string

      The URI of the contact to read

    Returns Promise<FullGroup>

    FullGroup name and list of group members

removeContactFromGroup

removeEmailAddress

  • removeEmailAddress(command): Promise<void>

  • Removes the given email address from the given contact

    Parameters

    Returns Promise<void>

removePhoneNumber

  • removePhoneNumber(command): Promise<void>

  • Removes the given phone number from the given contact

    Parameters

    Returns Promise<void>

renameContact

  • renameContact(command): Promise<void>

  • Changes the name of the given contact to a new value

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

addContactToGroupaddNewEmailAddressaddNewPhoneNumbercreateAddressBookcreateNewContactcreateNewGrouplistAddressBooksreadAddressBookreadContactreadGroupremoveContactFromGroupremoveEmailAddressremovePhoneNumberrenameContact

Generated using TypeDoc