Variable crmConst

Type Declaration

• getAccounts: function

  • getAccounts(): Promise<unknown>

    Get all CRM accounts synced for the current user.

    Returns Promise<unknown>

    Raw account records from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getAccount: function

  • getAccount(accountID: string): Promise<unknown>

    Get a specific CRM account by ID.

    Parameters

    • accountID: string

      The CRM account ID to fetch.

    Returns Promise<unknown>

    Raw account record from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getAddresses: function

  • getAddresses(): Promise<unknown>

    Get all CRM addresses synced for the current user.

    Returns Promise<unknown>

    Raw address records from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getAddress: function

  • getAddress(addressID: string): Promise<unknown>

    Get a specific CRM address by ID.

    Parameters

    • addressID: string

      The CRM address ID to fetch.

    Returns Promise<unknown>

    Raw address record from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getContacts: function

  • getContacts(): Promise<unknown>

    Get all CRM contacts synced for the current user.

    Returns Promise<unknown>

    Raw contact records from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getContact: function

  • getContact(contactID: string): Promise<unknown>

    Get a specific CRM contact by ID.

    Parameters

    • contactID: string

      The CRM contact ID to fetch.

    Returns Promise<unknown>

    Raw contact record from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getLeads: function

  • getLeads(): Promise<unknown>

    Get all CRM leads synced for the current user.

    Returns Promise<unknown>

    Raw lead records from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getLead: function

  • getLead(leadID: string): Promise<unknown>

    Get a specific CRM lead by ID.

    Parameters

    • leadID: string

      The CRM lead ID to fetch.

    Returns Promise<unknown>

    Raw lead record from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getUsers: function

  • getUsers(): Promise<unknown>

    Get all CRM users synced for the current team.

    Returns Promise<unknown>

    Raw user records from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• getUser: function

  • getUser(userID: string): Promise<unknown>

    Get a specific CRM user by ID.

    Parameters

    • userID: string

      The CRM user ID to fetch.

    Returns Promise<unknown>

    Raw user record from the connected CRM.

    Throws

    MobileLockerCRMError on network failure, auth expiry, or server error.

• openCustomerPicker: function

  • openCustomerPicker(): Promise<PickerResult>

    Open the native customer picker UI and let the user select one or more customers.

    Returns Promise<PickerResult>

    An object with status ('selected' or 'cancelled') and an optional customers array.

    Remarks

    iOS app only. Throws in all other environments.

    Throws

    MobileLockerError if called outside the iOS app.

    Throws

    MobileLockerCRMError on network failure or server error.

    Example

    const { status, customers } = await mobilelocker.crm.openCustomerPicker()
    if (status === 'selected') console.log(customers)
    Copy

• getCurrentCustomers: function

  • getCurrentCustomers(): Promise<Customer[]>

    Get the customers currently associated with the active presentation session.

    Returns Promise<Customer[]>

    Array of Customer objects.

    Throws

    MobileLockerCRMError on network failure or server error.

• getRecentCustomers: function

  • getRecentCustomers(): Promise<Customer[]>

    Get the customers most recently viewed by the current user.

    Returns Promise<Customer[]>

    Array of Customer objects, newest first.

    Throws

    MobileLockerCRMError on network failure or server error.

• isCurrentCustomer: function

  • isCurrentCustomer(objectID: string): Promise<boolean>

    Check whether a CRM object is currently associated with the active session.

    Parameters

    • objectID: string

      The CRM object ID to check (e.g. a Salesforce Account ID).

    Returns Promise<boolean>

    true if the customer is current, false otherwise.

    Throws

    MobileLockerCRMError on network failure or server error.

• setCurrentCustomers: function

  • setCurrentCustomers(customerIDs: string[]): Promise<void>

    Replace the current customers for the active session.

    Parameters

    • customerIDs: string[]

      Array of CRM object IDs to set as current.

    Returns Promise<void>

    Throws

    MobileLockerCRMError on network failure or server error.

• addCurrentCustomer: function

  • addCurrentCustomer(customerID: string): Promise<void>

    Add a single customer to the current session without replacing existing ones.

    Parameters

    • customerID: string

      The CRM object ID of the customer to add.

    Returns Promise<void>

    Throws

    MobileLockerCRMError on network failure or server error.

• removeCurrentCustomer: function

  • removeCurrentCustomer(customerID: string): Promise<void>

    Remove a single customer from the current session.

    Parameters

    • customerID: string

      The CRM object ID of the customer to remove.

    Returns Promise<void>

    Throws

    MobileLockerCRMError on network failure or server error.

• clearCurrentCustomers: function

  • clearCurrentCustomers(): Promise<void>

    Remove all customers from the current session.

    Returns Promise<void>

    Throws

    MobileLockerCRMError on network failure or server error.

• refresh: function

  • refresh(options?: { mode?: CRMRefreshMode }): Promise<CRMRefreshResult>

    Trigger a CRM data refresh for the current user.

    Parameters

    • Optionaloptions: { mode?: CRMRefreshMode }

      • Optionalmode?: CRMRefreshMode

        'incremental' (default) syncs only new/changed records; 'full' re-syncs everything.

    Returns Promise<CRMRefreshResult>

    An object with status: 'started' if the refresh was queued, 'not_connected' if the CRM is unreachable.

    Throws

    MobileLockerCRMError on auth expiry or server error.

    Example

    const { status } = await mobilelocker.crm.refresh({ mode: 'full' })
    Copy

• query: function

  • query(
        soql: string,
        parameters?: Record<string, unknown>,
    ): Promise<CRMQueryResult>

    Execute a SOQL query against the connected CRM.

    Parameters

    • soql: string

      A valid SOQL SELECT statement.

    • Optionalparameters: Record<string, unknown>

      Optional named bind parameters referenced in the SOQL string.

    Returns Promise<CRMQueryResult>

    A CRMQueryResult containing rows, totalSize, and done.

    Throws

    MobileLockerCRMError with code SOQLInvalid on a syntax error, or on network/auth failure.

    Example

    const result = await mobilelocker.crm.query('SELECT Id, Name FROM Account WHERE Name = :name', { name: 'Acme' })
    Copy