Interface IProfile

Batch's Profile Module.

interface IProfile {
    edit: ((callback: ((editor: IProfileDataEditor) => void)) => Promise<IProfile>);
    identify: ((identifier: undefined | null | {
        customId?: string;
    }) => Promise<IProfile>);
}

Properties

edit identify

Properties

edit

edit: ((callback: ((editor: IProfileDataEditor) => void)) => Promise<IProfile>)

Edit profile's attributes.

Type declaration

    • (callback): Promise<IProfile>

    • Parameters

      • callback: ((editor: IProfileDataEditor) => void)

        A callback which will be called with an instance of the profile data editor.

        To edit data, pass a function to this method. Batch will call it back with the profile data editor as its only parameter. Once your callback ends, Batch will persist the changes.

        If your edits result in your attributes going over the limit, an error will be logged and all of the changes described in the transaction will be rolled back, as if nothing happened. See https://doc.batch.com/web/custom-data/custom-attributes for more info about the limits.

        Escaping the editor instance is not supported: calling any method on it once your callback has ended will throw an exception.

        See ProfileDataEditor's documentation for the methods available in the user data editor.

        Return a promise that resolves the IProfile instance.

      Returns Promise<IProfile>

identify

identify: ((identifier: undefined | null | {
    customId?: string;
}) => Promise<IProfile>)

Identify the current user.

Attach the current installation to a Profile.

Type declaration

    • (identifier): Promise<IProfile>

    • Parameters

      • identifier: undefined | null | {
            customId?: string;
        }

        An object containing the customId.

        Return a promise that resolves the IProfile instance.

        See https://doc.batch.com/web/custom-data/customid for more info.

      Returns Promise<IProfile>

Settings

Member Visibility

On This Page

Properties