Type Alias ItemMethods

Type declaration

• list:function

  • list(data): Promise<{
        items: Item[];
        count: number;
    }>

  • Get a list of items with pagination.

    Requires AccessScope.ItemRead.

    Parameters

    • data: SpaceTarget & PaginationTarget & ItemTypeTarget
      • spaceId is the identifier of space
      • skip is number of spaces to skip
      • limit limits number of results (details)
      • glType (ItemType) filter items by type

    Returns Promise<{
        items: Item[];
        count: number;
    }>

    count of items and a list of items:

    • id is identifier of item
    • x is relative/absolute x coordinate
    • y is relative/absolute y coordinate
    • z is z-index value
    • width is width of item in space pixels
    • height is height of item is space pixels
    • ratio equals initial width divided by initial height
    • rotation is rotation of item in deg
    • scale is item scale, miss support, always has value 1.0
    • locked (GlLock) is lock status of item
    • visibility (GlVisibility) is item visibility
    • parent is identifier of parent or zero
    • creator is identifier of item creator (user/guest)
    • created is the creation timestamp as string (ISO 8601)
    • editor is identifier of item editor (user/guest)
    • edited is the editing timestamp as string (ISO 8601)
    • data is custom item data, see GlItem implementations
    • sizeOnDisk is file size in MiB or zero
    • version is actual version of item, version can be changed due to item migration to a new version

    Throws

    ModuleErrors.AccessRestricted;

• find:function

  • find(data): Promise<null | Item<GlItem>>

  • Find an item by id.

    Requires AccessScope.ItemRead.

    Parameters

    • data: ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item

    Returns Promise<null | Item<GlItem>>

    Null or object:

    • id is identifier of item
    • x is relative/absolute x coordinate
    • y is relative/absolute y coordinate
    • z is z-index value
    • width is width of item in space pixels
    • height is height of item is space pixels
    • ratio equals initial width divided by initial height
    • rotation is rotation of item in deg
    • scale is item scale, miss support, always has value 1.0
    • locked (GlLock) is lock status of item
    • visibility (GlVisibility) is item visibility
    • parent is identifier of parent or zero
    • creator is identifier of item creator (user/guest)
    • created is the creation timestamp as string (ISO 8601)
    • editor is identifier of item editor (user/guest)
    • edited is the editing timestamp as string (ISO 8601)
    • data is custom item data, see GlItem implementations
    • sizeOnDisk is file size in MiB or zero
    • version is actual version of item

    Throws

    ModuleErrors.AccessRestricted;

• edit:function

  • edit(data): Promise<boolean>

  • Edit an item, this method can change any editable field of item.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: ItemTarget & Partial<EditablePartOfItem>
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • width is width of item in space pixels
      • height is height of item is space pixels
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<boolean>

    true if item is present in the database

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• remove:function

  • remove(data): Promise<boolean>

  • Remove item from space.

    Requires AccessScope.ItemRemove.

    Parameters

    • data: ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item

    Returns Promise<boolean>

    true if an item was removed, otherwise false

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createDoor:function

  • createDoor(data): Promise<string>

  • Create a new door in space.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: Omit<EditablePartOfItem, "width" | "height" | "ratio"> & {
          targetId: ObjectId;
      } & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • targetId is destination space identifier
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of the created door

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createDrawing:function

  • createDrawing(data): Promise<string>

  • Create a drawing.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: Omit<EditablePartOfItem,
          | "width"
          | "height"
          | "ratio"
          | "x"
          | "y"> & Omit<FocusWriting, "glType" | "timed"> & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • data is value for d attribute of path tag
      • color (DrawingColor) is stroke color
      • size is stroke weight
      • z is z-index value
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of created drawing

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createFrame:function

  • createFrame(data): Promise<string>
  • Beta

    Create a frame.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: EditablePartOfItem & Pick<Frame, "name"> & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • name is screen name of the frame
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of created frame

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createImage:function

  • createImage(data): Promise<string>

  • Upload an image.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: EditablePartOfItem & {
          image: File;
      } & SpaceTarget & Pick<Image, "flip">
      • spaceId is identifier of space where item will be inserted
      • file is File to upload
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of created image

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

    Remarks

    The width and height are max values is this method

• createLink:function

  • createLink(data): Promise<string>

  • Create an external link.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: Omit<EditablePartOfItem, "width" | "height" | "ratio"> & Omit<Link, "glType"> & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • text is screen text of link
      • url is URL to follow
      • status (GlLinkStatus) is link behavior mode
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of the created link

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createPresentation:function

  • createPresentation(data): Promise<string>

  • Crete a presentation.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: EditablePartOfItem & {
          pdf: File;
      } & SpaceTarget & Pick<Presentation, "page">
      • spaceId is identifier of space where item will be inserted
      • file is File to upload
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of the created presentation

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

    Remarks

    Zero width/height will be replaced with auto values

• createSticker:function

  • createSticker(data): Promise<string>

  • Create a sticker.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: EditablePartOfItem & Omit<Sticker, "glType"> & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • text is sticker text
      • color (StickerColor) is background color
      • form (StickerForm) is sticker figure
      • hAlign (GlHTextAlign) is text horizontal align
      • vAlign (GlVTextAlign) is text vertical align
      • size is font size of text
      • borderColor (StickerBorderColor) is color of border
      • borderType (BorderType) is border style
      • borderSize is border width
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of the created sticker

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• createYoutube:function

  • createYoutube(data): Promise<string>

  • Create a YouTube video player.

    Requires AccessScope.ItemCreate.

    Parameters

    • data: EditablePartOfItem & Omit<Youtube, "glType"> & SpaceTarget
      • spaceId is identifier of space where item will be inserted
      • link is a YouTube embed link
      • position is play start position in seconds
      • x is relative/absolute x coordinate
      • y is relative/absolute y coordinate
      • z is z-index value
      • ratio equals initial width divided by initial height
      • rotation is rotation of item in deg
      • scale is item scale, miss support, always has value 1.0
      • locked (GlLock) is lock status of item
      • visibility (GlVisibility) is item visibility
      • parent is identifier of parent or zero

    Returns Promise<string>

    Identifier of the created player

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editDoor:function

  • editDoor(data): Promise<boolean>

  • Edit door target space.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: {
          targetId: ObjectId;
      } & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • targetId is destination space identifier

    Returns Promise<boolean>

    true if the door was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editDrawing:function

  • editDrawing(data): Promise<boolean>

  • Edit a drawing: the path, color and stroke width.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Partial<Pick<FocusWriting, "data" | "color" | "size">> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • data is value for d attribute of path tag
      • color (DrawingColor) is stroke color
      • size is stroke weight

    Returns Promise<boolean>

    true if the drawing was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editFrame:function

  • editFrame(data): Promise<boolean>
  • Beta

    Edit a frame name.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Pick<Frame, "name"> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • name is screen name of the frame

    Returns Promise<boolean>

    true if the frame was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editImage:function

  • editImage(data): Promise<boolean>

  • Edit an image flip.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Pick<Image, "flip"> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • flip is image flip state (Image.flip)

    Returns Promise<boolean>

    true if the image was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editLink:function

  • editLink(data): Promise<boolean>

  • Edit an external link url and text.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Partial<Pick<Link, "text" | "url" | "status">> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • text is the screen text of the link
      • url is URL to follow
      • status (GlLinkStatus) is link behavior mode

    Returns Promise<boolean>

    true if the external link was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editPresentation:function

  • editPresentation(data): Promise<boolean>

  • Edit presentation page.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Pick<Presentation, "page"> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • page is page number

    Returns Promise<boolean>

    true if presentation was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editSticker:function

  • editSticker(data): Promise<boolean>

  • Edit a sticker content, style and figure.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Partial<Omit<Sticker, "glType">> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • text is sticker text
      • color (StickerColor) is background color
      • form (StickerForm) is sticker figure
      • hAlign (GlHTextAlign) is text horizontal align
      • vAlign (GlVTextAlign) is text vertical align
      • size is font size of text
      • borderColor (StickerBorderColor) is color of border
      • borderType (BorderType) is border style
      • borderSize is border width

    Returns Promise<boolean>

    true if the sticker was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;

• editYoutube:function

  • editYoutube(data): Promise<boolean>

  • Edit player saved position.

    Requires AccessScope.ItemEdit.

    Parameters

    • data: Pick<Youtube, "position"> & ItemTarget
      • spaceId is the identifier of space
      • itemId is the identifier of item
      • position is play start position in seconds

    Returns Promise<boolean>

    true if video position was updated

    Throws

    ModuleErrors.AccessRestricted; ModuleErrors.NotFound;