@pnp/sp
Version:
pnp - provides a fluent api for working with SharePoint REST
77 lines • 4.18 kB
TypeScript
import { _SPQueryable, ISPQueryable } from "../spqueryable.js";
export declare class _RelatedItemManager extends _SPQueryable implements IRelatedItemManager {
getRelatedItems(sourceListName: string, sourceItemId: number): Promise<IRelatedItem[]>;
getPageOneRelatedItems(sourceListName: string, sourceItemId: number): Promise<IRelatedItem[]>;
addSingleLink(sourceListName: string, sourceItemId: number, sourceWebUrl: string, targetListName: string, targetItemID: number, targetWebUrl: string, tryAddReverseLink?: boolean): Promise<void>;
addSingleLinkToUrl(sourceListName: string, sourceItemId: number, targetItemUrl: string, tryAddReverseLink?: boolean): Promise<void>;
addSingleLinkFromUrl(sourceItemUrl: string, targetListName: string, targetItemId: number, tryAddReverseLink?: boolean): Promise<void>;
deleteSingleLink(sourceListName: string, sourceItemId: number, sourceWebUrl: string, targetListName: string, targetItemId: number, targetWebUrl: string, tryDeleteReverseLink?: boolean): Promise<void>;
}
export interface IRelatedItemManager {
/**
* Gets all the related items for the given item specification
*
* @param sourceListName The list name or list id
* @param sourceItemId The item id
*/
getRelatedItems(sourceListName: string, sourceItemId: number): Promise<IRelatedItem[]>;
/**
* Gets the first page of related items for the given item specification
*
* @param sourceListName The list name or list id
* @param sourceItemId The item id
*/
getPageOneRelatedItems(sourceListName: string, sourceItemId: number): Promise<IRelatedItem[]>;
/**
* Adds a single link using full specifications for source and target
*
* @param sourceListName The source list name or list id
* @param sourceItemId The source item id
* @param sourceWebUrl The source web absolute url
* @param targetListName The target list name or list id
* @param targetItemID The target item id
* @param targetWebUrl The target web absolute url
* @param tryAddReverseLink If set to true try to add the reverse link (will not return error if it fails)
*/
addSingleLink(sourceListName: string, sourceItemId: number, sourceWebUrl: string, targetListName: string, targetItemID: number, targetWebUrl: string, tryAddReverseLink?: boolean): Promise<void>;
/**
* Adds a related item link from an item specified by list name and item id, to an item specified by url
*
* @param sourceListName The source list name or list id
* @param sourceItemId The source item id
* @param targetItemUrl The target item url
* @param tryAddReverseLink If set to true try to add the reverse link (will not return error if it fails)
*/
addSingleLinkToUrl(sourceListName: string, sourceItemId: number, targetItemUrl: string, tryAddReverseLink?: boolean): Promise<void>;
/**
* Adds a related item link from an item specified by url, to an item specified by list name and item id
*
* @param sourceItemUrl The source item url
* @param targetListName The target list name or list id
* @param targetItemId The target item id
* @param tryAddReverseLink If set to true try to add the reverse link (will not return error if it fails)
*/
addSingleLinkFromUrl(sourceItemUrl: string, targetListName: string, targetItemId: number, tryAddReverseLink?: boolean): Promise<void>;
/**
* Deletes a single link
*
* @param sourceListName
* @param sourceItemId
* @param sourceWebUrl
* @param targetListName
* @param targetItemId
* @param targetWebUrl
* @param tryDeleteReverseLink
*/
deleteSingleLink(sourceListName: string, sourceItemId: number, sourceWebUrl: string, targetListName: string, targetItemId: number, targetWebUrl: string, tryDeleteReverseLink?: boolean): Promise<void>;
}
export declare const RelatedItemManager: (base: string | ISPQueryable) => IRelatedItemManager;
export interface IRelatedItem {
ListId: string;
ItemId: number;
Url: string;
Title: string;
WebId: string;
IconUrl: string;
}
//# sourceMappingURL=types.d.ts.map