@mikezimm/fps-core-v7/lib/components/molecules/AnyContent/IAnyContent.d.ts

Library of reusable core interfaces, types and constants migrated from fps-library-v2

/**
 * Originally copied from IAnyContent in ALVFinMan.
 * Meant to be parent to be extended.
 */
import { IContentGroup } from "../SearchPage/Interfaces/IContentGroup";
import { IFPSItemIsA } from "./IsA/IFPSItemIsA";
import { IFPSItemStyles } from "./IFPSItemStyles";
import { IFPSItemTime } from "./IFPSItemTime";
import { IFPSItemFile } from "./IFPSItemFile";
import { IFPSItemSearch } from "./IFPSItemSearch";
import { IFPSItemPerson } from "./IFPSItemPerson";
import { IFPSItemRelated } from "./IFPSItemRelated";
import { IFPSItemElements } from "./IFPSItemElements";
import { IAnySecurableItem } from "./IAnySecurableItem";
import { IAnyLibrary, IAnyList } from "./IAnyListLib";
import { IAnyWeb } from "./IAnyWeb";
import { IMinReactMouseEvent } from "../../../types/react/IReactEvents";
import { ClientsidePageLayoutType } from "../../../types/@pnp/@2.14.0/sp/clientside-pages";
import { IAttachmentInfo } from "../../../types/@pnp/@2.14.0/sp/attachments";
export declare const ReadOnlyListItemProps: string[];
export interface IAnyListItem extends IAnySecurableItem {
    Title?: string;
    Description?: string;
    Created?: string;
    createdAge?: number;
    Modified?: string;
    modifiedAge?: number;
    Author?: any;
    Editor?: any;
    'Author/Title'?: string;
    'Editor/Title'?: string;
    'Author/Name'?: string;
    'Editor/Name'?: string;
    'Author/Id'?: string;
    'Editor/Id'?: string;
    'Author/Office'?: string;
    'Editor/Office'?: string;
    'ContentType/Name'?: string;
    Id?: any;
    ID?: any;
    OData__UIVersionString?: any;
    OData__UIVersion?: any;
    AttachmentFiles?: IAttachmentInfo;
}
export interface IAnyFileItem extends IAnyListItem {
    File?: any;
    FileRef?: string;
    FileLeafRef?: string;
    ServerRedirectedEmbedUri?: string;
    ServerRedirectedEmbedUrl?: string;
    File_x0020_Type?: string;
    DocIcon?: string;
    FileSizeDisplay?: string;
    FileSystemObjectType?: 0 | 1;
    CheckoutUserId?: any;
    'File/ServerRelativeUrl'?: string;
    /**
      * OData__OriginalSourceUrl is a hidden column in SharePoint Online that is used to store the original URL of a document that was uploaded to SharePoint. This column is used by the SharePoint Online search engine to crawl and index documents. It is not recommended to modify or delete this column as it can cause issues with search results and other SharePoint Online features¹.
  
      I hope this helps! Let me know if you have any other questions.
  
      Source: Conversation with Bing, 7/6/2023
      (1) Use OData query operations in SharePoint REST requests. https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/use-odata-query-operations-in-sharepoint-rest-requests.
      (2) OData Source for SharePoint Online - social.msdn.microsoft.com. https://social.msdn.microsoft.com/Forums/en-US/58807617-90aa-48e3-a06f-9582b683d8de/odata-source-for-sharepoint-online?forum=sharepointadmin.
      (3) Working with SharePoint Online through OData v4 Endpoint - KingswaySoft. http://www.kingswaysoft.com/blog/2021/06/29/Working-with-SharePoint-Online-through-OData-v4-Endpoint.
      (4) Using OData sources with Business Connectivity Services in SharePoint .... https://learn.microsoft.com/en-us/sharepoint/dev/general-development/using-odata-sources-with-business-connectivity-services-in-sharepoint.
    */
    OData__OriginalSourceUrl?: string;
}
export interface IAnySearchableItem {
    ViewsLifeTime?: number;
    ViewsRecent?: number;
    PopularLifeTime?: number;
    PopularRecent?: number;
}
export interface IAnyPageItem extends IAnyFileItem {
    ServerRelativeUrl?: string;
    CanvasContent1?: string;
    LayoutWebpartsContent?: string;
    OData__OriginalSourceUrl?: string;
    OData__OriginalSourceSiteId?: string;
    PageLayoutType?: ClientsidePageLayoutType;
    Title?: string;
    Description?: string;
    BannerImageUrl?: {
        Url: string;
        Description?: string;
    };
    'File/ServerRelativeUrl'?: string;
}
export interface IAnyNewsItem extends IAnyPageItem {
    FirstPublishedDate?: string;
    publishedAge?: number;
    PromotedState?: 0 | 1 | 2;
    OData__OriginalSourceUrl?: string;
}
export interface IAnySourceItem extends IAnyListItem, IAnyFileItem, IAnyPageItem, IAnyNewsItem, IAnySecurableItem, IAnyList, IAnyLibrary, IAnyWeb, IAnySearchableItem {
    FPSItem: IFPSItem;
}
export interface IAnySourceItemAny extends IAnySourceItem, Partial<any> {
}
export interface IFPSItem {
    Stamp?: IFPSItemStamp;
    Image?: IFPSItemImage;
    Link?: IFPSItemLink;
    Icon?: IFPSItemIcon;
    Search: IFPSItemSearch;
    Suggestion?: IFPSItemSug;
    Font?: IFPSItemFont;
    File: IFPSItemFile;
    IsA: IFPSItemIsA;
    Related?: IFPSItemRelated;
    Elements?: IFPSItemElements;
    contentGroup?: IContentGroup;
}
export interface IFPSItemStamp extends IFPSItemStyles {
    created?: IFPSItemTime;
    modified?: IFPSItemTime;
    published?: IFPSItemTime;
    editor?: IFPSItemPerson;
    author?: IFPSItemPerson;
    createdNote?: string;
    modifiedNote?: string;
}
export interface IFPSItemImage extends IFPSItemStyles {
    src: string;
    href?: string;
}
export interface IFPSItemLink extends IFPSItemStyles {
    href: string;
    title?: string;
    description?: string;
    status?: number;
    altUrl?: string;
    ctrlUrl?: string;
    shiftUrl?: string;
    metaUrl?: string;
    key3Url?: string;
    altClick?: (event: IMinReactMouseEvent, item: IAnySourceItem) => void;
    callbackClick?: (event: IMinReactMouseEvent, item: IAnySourceItem) => void;
}
export interface IFPSItemIcon extends IFPSItemStyles {
    name: string;
}
export interface IFPSItemSug {
}
export interface IFPSItemFont extends IFPSItemStyles {
}
//# sourceMappingURL=IAnyContent.d.ts.map