@mikezimm/npmfunctions/dist/Lists/listTypes.d.ts

Functions used in my SPFx webparts

/**
 * Ensures that the specified list exists in the collection (note: this method not supported for batching)
 *
 * @param title The new list's title
 * @param desc The new list's description
 * @param template The list template value
 * @param enableContentTypes If true content types will be allowed and enabled, otherwise they will be disallowed and not enabled
 * @param additionalSettings Will be passed as part of the list creation body or used to update an existing list
 */
export declare function notify(statusLog: IServiceLog | any, verb: any, status: any, step: any, f: any, returnField: any, checkValue?: any, noAlert?: boolean): any;
export interface IServiceLog {
    [key: string]: string | any | undefined;
    time: string;
    step: string;
    verb: string;
    status: string;
    checkValue?: any;
    returnField?: any;
    item?: any;
}
export interface IMyListInfo {
    [key: string]: string | number | boolean | string[] | Partial<IListInfo> | undefined;
    webURL?: string;
    title: string;
    desc?: string;
    template?: number;
    enableContentTypes?: boolean;
    additionalSettings?: Partial<IListInfo>;
}
export interface IListInfo {
    [key: string]: string | number | boolean | {
        DecodedUrl: string;
    } | undefined;
    EnableRequestSignOff: boolean;
    EnableVersioning: boolean;
    EntityTypeName: string;
    ExemptFromBlockDownloadOfNonViewableFiles: boolean;
    FileSavePostProcessingEnabled: boolean;
    ForceCheckout: boolean;
    HasExternalDataSource: boolean;
    Hidden: boolean;
    Id: string;
    ImagePath: {
        DecodedUrl: string;
    };
    ImageUrl: string;
    IrmEnabled: boolean;
    IrmExpire: boolean;
    IrmReject: boolean;
    IsApplicationList: boolean;
    IsCatalog: boolean;
    IsPrivate: boolean;
    ItemCount: number;
    HasUniqueRoleAssignments: boolean;
    LastItemDeletedDate: string;
    LastItemModifiedDate: string;
    LastItemUserModifiedDate: string;
    ListExperienceOptions: number;
    ListItemEntityTypeFullName: string;
    MajorVersionLimit: number;
    MajorWithMinorVersionsLimit: number;
    MultipleDataList: boolean;
    NoCrawl: boolean;
    ParentWebPath: {
        DecodedUrl: string;
    };
    ParentWebUrl: string;
    ParserDisabled: boolean;
    ServerTemplateCanCreateFolders: boolean;
    TemplateFeatureId: string;
    Title: string;
    UniquePerms?: boolean;
}
export interface IContentsLists {
    [key: string]: string[] | any | undefined;
    tabs: string[];
    lists: {
        all: IContentsListInfo[];
        searched: IContentsListInfo[];
    };
}
export interface IContentsListInfo {
    [key: string]: string | number | boolean | any | undefined;
    AllowContentTypes?: boolean;
    ContentTypesEnabled: boolean;
    BaseTemplate: number;
    BaseType: number;
    EntityTypeName: string;
    Title: string;
    Hidden: boolean;
    Id: string;
    Description: string;
    ItemCount: number;
    Created: string;
    HasUniqueRoleAssignments: boolean;
    LastItemDeletedDate: string;
    LastItemModifiedDate: string;
    LastItemUserModifiedDate: string;
    ParentWebPath: {
        DecodedUrl: string;
    };
    ParentWebUrl: string;
    listURL: string;
    railsOffLink: boolean;
    allowCrazyLink: boolean;
    responseIndex: any;
    EnableRequestSignOff: boolean;
    EnableVersioning: boolean;
    EnableMinorVersions: boolean;
    MajorVersionLimit: number;
    MajorWithMinorVersionsLimit: number;
    DraftVersionVisibility: number;
    ForceCheckout: boolean;
    EnableModeration: boolean;
    ServerTemplateCanCreateFolders: boolean;
    EnableAttachments: boolean;
    NoCrawl: boolean;
    UniquePerms?: boolean;
    searchString: string;
    modifiedAge?: number;
    modifiedSettingAge?: number;
    createdAge?: number;
    modifiedUserAge?: number;
    deletedAge?: number;
    meta?: string[];
    sort: string;
    bucketCategory: string;
    bucketLabel: string;
    bucketIdx: any;
    odataEtag: string;
    odataId: string;
    ListItemEntityTypeFullName: string;
    ImagePath: {
        DecodedUrl: string;
    };
    ImageUrl: string;
    IrmEnabled: boolean;
    IrmExpire: boolean;
    IrmReject: boolean;
    IsApplicationList: boolean;
    IsCatalog: boolean;
    IsPrivate: boolean;
    TemplateFeatureId: string;
    HasExternalDataSource: boolean;
    ExemptFromBlockDownloadOfNonViewableFiles?: boolean;
    FileSavePostProcessingEnabled?: boolean;
    ParserDisabled: boolean;
    ListExperienceOptions: number;
    MultipleDataList: boolean;
}