@nextcloud/sharing
    Preparing search index...

    Interface IGenericShare

    interface IGenericShare {
        attributes: ShareAttribute[];
        canDelete: boolean;
        canEdit: boolean;
        createdTime: number;
        expireDate?: `${number}-${number}-${number} ${number}:${number}`;
        fileOwner: string;
        fileOwnerDisplayname: string;
        hideDownload: boolean;
        id: number;
        label?: string;
        mailSend: boolean;
        note?: string;
        owner: string;
        ownerDisplayname: string;
        permissions: number;
        shareWith: string;
        shareWithDisplayname: string;
        shareWithDisplaynameUnique: string;
        type: ShareType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes canDelete canEdit createdTime expireDate? fileOwner fileOwnerDisplayname hideDownload id label? mailSend note? owner ownerDisplayname permissions shareWith shareWithDisplayname shareWithDisplaynameUnique type

    Properties

    attributes: ShareAttribute[]

    The generic share attributes

    canDelete: boolean

    Whether the current user can delete this share. Only relevant for existing shares.

    canEdit: boolean

    Whether the current user can edit this share. Only relevant for existing shares.

    createdTime: number

    The share creation timestamp (in seconds since UNIX epoch)

    expireDate?: `${number}-${number}-${number} ${number}:${number}`

    The share expiration date in "YYYY-MM-DD HH:mm" format

    fileOwner: string

    The uid of the owner of the shared file or folder.

    fileOwnerDisplayname: string

    The displayname of the owner of the shared file or folder.

    hideDownload: boolean

    Hide the download functionalities for the shared nodes. This obfuscates the download buttons for such shares.

    id: number

    The share id

    label?: string

    The share label

    mailSend: boolean

    Have a mail been sent to the share recipient

    note?: string

    The share note

    owner: string

    The uid of the share owner

    ownerDisplayname: string

    The displayname of the share owner

    permissions: number

    The share permissions for the share receiver.

    A bitmask of the share permissions like SharePermission.Read | SharePermission.Write. These are not the permissions for the current user but for the share recipient (shareWith).

    shareWith: string

    Get the share with entity id

    shareWithDisplayname: string

    The displayname of the entity this was shared with

    shareWithDisplaynameUnique: string

    In case of multiple shares with the same entity this is the unique displayname.

    type: ShareType

    The share type

    Settings

    Member Visibility

    On This Page

    Properties