hp-app-bundle-sdk/dist/modules/contacts/types.d.ts

A comprehensive SDK for building mini-applications.

export interface Contact {
    id: string;
    name: string;
    phoneNumbers: PhoneNumber[];
    emails: Email[];
    addresses?: Address[];
    organization?: string;
    jobTitle?: string;
    note?: string;
    birthday?: string;
    avatar?: string;
}
export interface PhoneNumber {
    type: "mobile" | "home" | "work" | "other";
    number: string;
}
export interface Email {
    type: "home" | "work" | "other";
    address: string;
}
export interface Address {
    type: "home" | "work" | "other";
    street?: string;
    city?: string;
    state?: string;
    postalCode?: string;
    country?: string;
}
export interface ContactsConfig {
    requestPermissionOnInit: boolean;
    defaultFields: Array<keyof Contact>;
}
export interface ContactsPermissionResult {
    granted: boolean;
    canAskAgain: boolean;
    status: "granted" | "denied" | "never_ask_again";
}
export interface IContactsModule {
    checkPermission(): Promise<ContactsPermissionResult>;
    requestPermission(): Promise<ContactsPermissionResult>;
    getContacts(fields?: Array<keyof Contact>): Promise<Contact[]>;
    getContactById(id: string, fields?: Array<keyof Contact>): Promise<Contact | null>;
    searchContacts(query: string, fields?: Array<keyof Contact>): Promise<Contact[]>;
}
//# sourceMappingURL=types.d.ts.map