SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IPerson

    A person known to the workbook: the author of a comment, or someone mentioned in one.

    Excel keeps these in a workbook-wide list (xl/persons/person.xml) and refers to each by id from every threaded comment. A legacy note names its author by display name alone; the reader mints a person for it so both kinds answer IComment.getAuthor the same way.

    A person is added when a comment names an author the workbook has not seen, and removed with delete; a comment whose author was removed answers null for them.

    interface IPerson {
        isIPerson: true;
        delete(): void;
        getDisplayName(): string;
        getId(): string;
        getProviderId(): string | null;
        getUserId(): string | null;
        isDeleted(): boolean;
        toJSON(): IPerson.JSON;
    }
    Index
    isIPerson
    delete getDisplayName getId getProviderId getUserId isDeleted toJSON
    isIPerson: true

    For runtime type checking.

    • Removes the person from the workbook.

      Returns void

      Comments they wrote keep their text and lose their author.

    • The name shown beside the person's comments.

      Returns string

    • The unique identifier.

      Returns string

      A GUID in files Excel wrote; anything unique within the workbook otherwise.

    • The identity provider that vouches for the user id, or null if there is none.

      Returns string | null

      Excel writes AD for a directory account, Windows Live for a personal one, and None for a name typed with no account behind it.

    • The id the person is known by to their identity provider, or null if there is none.

      Returns string | null

      Excel keeps an email address here for a person signed in to an organization. Nothing in SheetXL resolves it.

    • Returns true once the person has been removed.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods