Plants vs. Zombies: Replanted - v1.0.3
    Preparing search index...

    Interface INexusAPIExtension

    interface INexusAPIExtension {
        nexusCheckModsVersion?: (
            gameId: string,
            mods: { [modId: string]: IMod },
            forceFull: boolean | "silent",
        ) => void;
        nexusDownload?: (
            gameId: string,
            modId: number,
            fileId: number,
            fileName?: string,
            allowInstall?: boolean,
        ) => PromiseLike<string>;
        nexusDownloadUpdate?: (
            source: string,
            gameId: string,
            modId: string,
            fileId: string,
            versionPattern: string,
            campaign: string,
            referenceTag?: string,
        ) => PromiseLike<{ dlId?: string; error: Error }>;
        nexusEndorseDirect?: (
            gameId: string,
            nexusId: number,
            version: string,
            endorsedStatus: EndorsedStatus,
        ) => PromiseLike<EndorsedStatus>;
        nexusEndorseMod?: (
            gameId: string,
            modId: string,
            endorsedStatus: EndorsedStatus,
        ) => void;
        nexusGetCollection?: (slug: string) => PromiseLike<ICollection>;
        nexusGetCollectionRevision?: (
            collectionSlug: string,
            revisionNumber: number,
        ) => PromiseLike<IRevision>;
        nexusGetCollections?: (gameId: string) => PromiseLike<ICollection[]>;
        nexusGetLatestMods?: (gameId: string) => PromiseLike<any>;
        nexusGetModFiles?: (
            gameId: string,
            modId: number,
        ) => PromiseLike<IFileInfo[]>;
        nexusGetMyCollections?: (
            gameId: string,
            count?: number,
            offset?: number,
        ) => PromiseLike<IRevision[]>;
        nexusGetPreferences?: (query: IPreferenceQuery) => PromiseLike<IPreference>;
        nexusGetTrendingMods?: (gameId: string) => PromiseLike<any>;
        nexusGetUserKeyData?: () => PromiseLike<IValidateKeyDataV2>;
        nexusModFileContents?: (
            query: IModFileContentPageQuery,
            filter?: any,
            offset?: number,
            count?: number,
        ) => PromiseLike<IModFileContentPage>;
        nexusModUpdate?: (
            gameId: string,
            modId: number,
            fileId: number,
            source: string,
        ) => void;
        nexusOpenCollectionPage?: (
            gameId: string,
            collectionSlug: string,
            revisionNumber: number,
            source: string,
        ) => void;
        nexusOpenModPage?: (gameId: string, modId: string, source: string) => void;
        nexusRateCollectionRevision?: (
            revisionId: number,
            rating: number,
        ) => PromiseLike<any>;
        nexusRequestNexusLogin?: (callback: any) => void;
        nexusRequestOwnIssues?: (
            cb: (err: Error, issues?: IIssue[]) => void,
        ) => void;
        nexusResolveCollectionUrl?: (
            apiLink: string,
        ) => PromiseLike<IDownloadURL[]>;
        nexusRetrieveCategoryList?: (isUpdate: boolean) => void;
        nexusSearchCollections?: (
            options: ICollectionSearchOptions,
        ) => PromiseLike<ICollectionSearchResult>;
        nexusSubmitCollection?: (
            collectionInfo: ICollectionManifest,
            assetFilePath: string,
            collectionId: number,
            callback: (err: Error, response?: any) => void,
        ) => void;
        nexusSubmitFeedback?: (
            title: string,
            message: string,
            hash: string,
            feedbackFiles: string[],
            anonymous: boolean,
            callback: (err: Error, response?: any) => void,
        ) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    nexusCheckModsVersion?: (
        gameId: string,
        mods: { [modId: string]: IMod },
        forceFull: boolean | "silent",
    ) => void
    nexusDownload?: (
        gameId: string,
        modId: number,
        fileId: number,
        fileName?: string,
        allowInstall?: boolean,
    ) => PromiseLike<string>
    nexusDownloadUpdate?: (
        source: string,
        gameId: string,
        modId: string,
        fileId: string,
        versionPattern: string,
        campaign: string,
        referenceTag?: string,
    ) => PromiseLike<{ dlId?: string; error: Error }>
    nexusEndorseDirect?: (
        gameId: string,
        nexusId: number,
        version: string,
        endorsedStatus: EndorsedStatus,
    ) => PromiseLike<EndorsedStatus>
    nexusEndorseMod?: (
        gameId: string,
        modId: string,
        endorsedStatus: EndorsedStatus,
    ) => void
    nexusGetCollection?: (slug: string) => PromiseLike<ICollection>
    nexusGetCollectionRevision?: (
        collectionSlug: string,
        revisionNumber: number,
    ) => PromiseLike<IRevision>
    nexusGetCollections?: (gameId: string) => PromiseLike<ICollection[]>
    nexusGetLatestMods?: (gameId: string) => PromiseLike<any>
    nexusGetModFiles?: (gameId: string, modId: number) => PromiseLike<IFileInfo[]>
    nexusGetMyCollections?: (
        gameId: string,
        count?: number,
        offset?: number,
    ) => PromiseLike<IRevision[]>
    nexusGetPreferences?: (query: IPreferenceQuery) => PromiseLike<IPreference>
    nexusGetTrendingMods?: (gameId: string) => PromiseLike<any>
    nexusGetUserKeyData?: () => PromiseLike<IValidateKeyDataV2>
    nexusModFileContents?: (
        query: IModFileContentPageQuery,
        filter?: any,
        offset?: number,
        count?: number,
    ) => PromiseLike<IModFileContentPage>
    nexusModUpdate?: (
        gameId: string,
        modId: number,
        fileId: number,
        source: string,
    ) => void
    nexusOpenCollectionPage?: (
        gameId: string,
        collectionSlug: string,
        revisionNumber: number,
        source: string,
    ) => void
    nexusOpenModPage?: (gameId: string, modId: string, source: string) => void
    nexusRateCollectionRevision?: (
        revisionId: number,
        rating: number,
    ) => PromiseLike<any>
    nexusRequestNexusLogin?: (callback: any) => void
    nexusRequestOwnIssues?: (cb: (err: Error, issues?: IIssue[]) => void) => void
    nexusResolveCollectionUrl?: (apiLink: string) => PromiseLike<IDownloadURL[]>
    nexusRetrieveCategoryList?: (isUpdate: boolean) => void
    nexusSearchCollections?: (
        options: ICollectionSearchOptions,
    ) => PromiseLike<ICollectionSearchResult>
    nexusSubmitCollection?: (
        collectionInfo: ICollectionManifest,
        assetFilePath: string,
        collectionId: number,
        callback: (err: Error, response?: any) => void,
    ) => void
    nexusSubmitFeedback?: (
        title: string,
        message: string,
        hash: string,
        feedbackFiles: string[],
        anonymous: boolean,
        callback: (err: Error, response?: any) => void,
    ) => void