@kwiz/common/lib/types/utils/sharepoint.rest/item.d.ts

KWIZ common utilities and helpers for M365 platform

import { IDictionary } from "../../types/common.types";
import { IAttachmentInfo, IFieldInfoEX, TaxonomyValueType } from "../../types/sharepoint.types";
import { IRestItem } from "../../types/sharepoint.utils.types";
/** can only select FileSizeDisplay in REST api */
export declare const FileSizeColumnInternalNames: string[];
export declare function GetListItemFieldDisplayValueSync(siteUrl: string, listIdOrTitle: string, itemId: number | string, field: string): string;
export declare function GetListItemFieldDisplayValuesSync(siteUrl: string, listIdOrTitle: string, itemId: number | string, fields: string[]): IDictionary<string>;
export declare function GetListItemFieldDisplayValue(siteUrl: string, listIdOrTitle: string, itemId: number | string, field: string, options?: {
    refreshCache?: boolean;
}): Promise<string>;
export declare function GetListItemFieldDisplayValues(siteUrl: string, listIdOrTitle: string, itemId: number | string, fields: string[], options?: {
    refreshCache?: boolean;
}): Promise<{
    [fieldName: string]: string;
}>;
export declare function GetListItemFieldValue(siteUrl: string, listIdOrTitle: string, itemId: number | string, field: string, options?: {
    refreshCache?: boolean;
}): Promise<any>;
export declare function GetListItemFieldValues(siteUrl: string, listIdOrTitle: string, itemId: number | string, fields: string[], options?: {
    refreshCache?: boolean;
}): Promise<{
    [fieldName: string]: any;
}>;
/** Returns version array, newest version first. Can get moderator comments, cannot get file check in comments */
export declare function GetListItemFieldValuesHistory(siteUrl: string, listIdOrTitle: string, itemId: number | string, fields: string[], options?: {
    refreshCache?: boolean;
}): Promise<IRestItem[]>;
export declare function DeleteListItem(siteUrl: string, listIdOrTitle: string, itemId: number | string): Promise<{
    deleted: boolean;
    errorMessage?: string;
}>;
export declare function RecycleListItem(siteUrl: string, listIdOrTitle: string, itemId: number | string): Promise<{
    recycled: boolean;
    errorMessage?: string;
}>;
export declare function GetListItemAttachments(siteUrl: string, listIdOrTitle: string, itemId: number): Promise<IAttachmentInfo[]>;
export declare function GetListItemsAttachments(siteUrl: string, listIdOrTitle: string, itemIds: number[]): Promise<{
    Id: number;
    AttachmentFiles: IAttachmentInfo[];
}[]>;
export declare function AddAttachment(siteUrl: string, listIdOrTitle: string, itemId: number, filename: string, buffer: ArrayBuffer): Promise<IAttachmentInfo>;
export declare function DeleteAttachment(siteUrl: string, listIdOrTitle: string, itemId: number, filename: string): Promise<IAttachmentInfo>;
export declare function UpdateMultiTaxonomyValue(siteUrl: string, listIdOrTitle: string, itemId: number, updates: IDictionary<TaxonomyValueType[]>): Promise<{
    field: string;
    error: string;
}[]>;
export declare function AddItem(siteUrl: string, listIdOrTitle: string, fieldValues: IDictionary<any>): Promise<{
    success: boolean;
    itemId: number;
    errorMessage?: undefined;
} | {
    success: boolean;
    errorMessage: string;
    itemId: number;
}>;
export interface UpdateItemType {
    updateProps: {
        success: boolean;
        itemId: number;
        errorMessage?: undefined;
    } | {
        success: boolean;
        errorMessage: string;
        itemId: number;
    };
}
export declare function UpdateItem(siteUrl: string, listIdOrTitle: string, itemId: number, fieldValues: IDictionary<any>, options?: {
    updateIfNoFields?: boolean;
}): Promise<{
    success: boolean;
    itemId: number;
    errorMessage?: undefined;
} | {
    success: boolean;
    errorMessage: string;
    itemId: number;
}>;
/** Get a sharepoint field value as text, from a rest item */
export declare function GetSPRestItemValueAsText(item: IRestItem, field: IFieldInfoEX): string;
/** Get a sharepoint field value as text array, from a rest item */
export declare function GetSPRestItemValueAsTextArray(item: IRestItem, field: IFieldInfoEX): string[];
/** prefer to use GetSPRestValueAsText instead */
export declare function GetSPFieldValueAsText(value: any, field: IFieldInfoEX): string[];
/** set an existing item system info: author, editor, created and modified dates */
export declare function SetItemCreatedModifiedInfo(siteUrl: string, listIdOrTitle: string, itemId: number, updates: {
    Created?: string | Date;
    Modified?: string | Date;
    AuthorId?: number;
    EditorId?: number;
}): Promise<{
    field: string;
    error: string;
}[]>;
export declare function ListItemHasUniquePermissions(siteUrl: string, listIdOrTitle: string, itemId: number): Promise<boolean>;
export declare function RestoreListItemPermissionInheritance(siteUrl: string, listIdOrTitle: string, itemId: number): Promise<void>;
export declare function BreakListItemPermissionInheritance(siteUrl: string, listIdOrTitle: string, itemId: number, clear?: boolean): Promise<void>;
export declare function AssignListItemPermission(siteUrl: string, listIdOrTitle: string, itemId: number, principalId: number, roleId: number): Promise<void>;
export declare function RemoveListItemPermission(siteUrl: string, listIdOrTitle: string, itemId: number, principalId: number, roleId: number): Promise<void>;
export declare function GetItemEffectiveBasePermissions(siteUrlOrId: string, listIdOrTitle: string, itemId: number): Promise<{
    High: number;
    Low: number;
}>;