- MockWorkspace(overrides?): DeviceApi.Workspace
Parameters
Optionaloverrides: {
canDelete?: boolean;
canEdit?: boolean;
canManageAccess?: boolean;
canShare?: boolean;
canView?: boolean;
created?: string;
createdBy?: string;
creatorId?: string;
editors?: (undefined | {
id?: string;
name?: string;
})[];
folderThemes?: {};
isFavorite?: boolean;
layout?: {
rows?: (undefined | {
metadata?: {
backgroundColor?: (...) | (...);
backgroundImageFileSlug?: (...) | (...);
backgroundImageSlug?: (...) | (...);
backgroundImageXPosition?: (...) | (...);
backgroundImageYPosition?: (...) | (...);
padding?: (...) | (...);
textColor?: (...) | (...);
};
sections?: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
})[];
};
metadata?: {
backgroundColor?: string;
backgroundImageFileSlug?: string;
backgroundImageSlug?: string;
backgroundImageXPosition?: XPosition;
backgroundImageYPosition?: YPosition;
backgroundVideoSlug?: string;
backgroundVideoXPosition?: XPosition;
backgroundVideoYPosition?: YPosition;
contentItemStyle?: {
contentItemDisplayType?: ContentItemDisplayType;
gridStyle?: {
corner?: "rounded" | "straight";
frameColor?: string;
hasFrame?: boolean;
hasShadow?: boolean;
hideFolderCount?: boolean;
thumbnailShape?: "square" | "imageRatio";
titleLength?: "oneLine" | "fullText" | "twoLines";
titleStyle?: "attached" | "detached" | "floating";
titleTextColor?: "light" | "dark";
};
};
dependencies?: (undefined | {
id?: string;
type?: string;
})[];
homePageSlug?: string;
initiallyHideMenus?: boolean;
isTemplate?: boolean;
navigationBackgroundColor?: string;
navigationTextColor?: TextColor;
templateSlug?: string;
textColor?: TextColor;
thumbnail?: {
slug?: string;
type?: ImageSourceType;
};
title?: string;
};
modified?: string;
pages?: (undefined | {
layout?: {
rows?: ((...) | (...))[];
};
metadata?: {
backgroundColor?: string;
backgroundImageFileSlug?: string;
backgroundImageSlug?: string;
backgroundImageXPosition?: XPosition;
backgroundImageYPosition?: YPosition;
backgroundVideoSlug?: string;
backgroundVideoXPosition?: XPosition;
backgroundVideoYPosition?: YPosition;
contentItemStyle?: {
contentItemDisplayType?: (...) | (...);
gridStyle?: (...) | (...);
};
textColor?: TextColor;
title?: string;
type?: WorkspacePageType;
};
slug?: string;
workspaceSlug?: string;
})[];
permissions?: (undefined | {
assigneeId?: string;
assigneeName?: string;
assigneeType?: string;
permission?: string;
})[];
shares?: [];
slug?: string;
thumbnailUrl?: string;
type?: "Workspace";
versionTags?: {};
workspaceVersion?: string;
}OptionalcanDelete?: boolean
OptionalcanEdit?: boolean
OptionalcanManageAccess?: boolean
OptionalcanShare?: boolean
OptionalcanView?: boolean
Optionalcreated?: string
OptionalcreatedBy?: string
OptionalcreatorId?: string
Optionaleditors?: (undefined | {
id?: string;
name?: string;
})[]
OptionalfolderThemes?: {}
OptionalisFavorite?: boolean
Optionallayout?: {
rows?: (undefined | {
metadata?: {
backgroundColor?: (...) | (...);
backgroundImageFileSlug?: (...) | (...);
backgroundImageSlug?: (...) | (...);
backgroundImageXPosition?: (...) | (...);
backgroundImageYPosition?: (...) | (...);
padding?: (...) | (...);
textColor?: (...) | (...);
};
sections?: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
})[];
}
Optionalrows?: (undefined | {
metadata?: {
backgroundColor?: (...) | (...);
backgroundImageFileSlug?: (...) | (...);
backgroundImageSlug?: (...) | (...);
backgroundImageXPosition?: (...) | (...);
backgroundImageYPosition?: (...) | (...);
padding?: (...) | (...);
textColor?: (...) | (...);
};
sections?: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...))[];
})[]
Optionalmetadata?: {
backgroundColor?: string;
backgroundImageFileSlug?: string;
backgroundImageSlug?: string;
backgroundImageXPosition?: XPosition;
backgroundImageYPosition?: YPosition;
backgroundVideoSlug?: string;
backgroundVideoXPosition?: XPosition;
backgroundVideoYPosition?: YPosition;
contentItemStyle?: {
contentItemDisplayType?: ContentItemDisplayType;
gridStyle?: {
corner?: "rounded" | "straight";
frameColor?: string;
hasFrame?: boolean;
hasShadow?: boolean;
hideFolderCount?: boolean;
thumbnailShape?: "square" | "imageRatio";
titleLength?: "oneLine" | "fullText" | "twoLines";
titleStyle?: "attached" | "detached" | "floating";
titleTextColor?: "light" | "dark";
};
};
dependencies?: (undefined | {
id?: string;
type?: string;
})[];
homePageSlug?: string;
initiallyHideMenus?: boolean;
isTemplate?: boolean;
navigationBackgroundColor?: string;
navigationTextColor?: TextColor;
templateSlug?: string;
textColor?: TextColor;
thumbnail?: {
slug?: string;
type?: ImageSourceType;
};
title?: string;
}
OptionalbackgroundColor?: string
OptionalbackgroundImageFileSlug?: string
OptionalbackgroundImageSlug?: string
OptionalbackgroundImageXPosition?: XPosition
OptionalbackgroundImageYPosition?: YPosition
OptionalbackgroundVideoSlug?: string
OptionalbackgroundVideoXPosition?: XPosition
OptionalbackgroundVideoYPosition?: YPosition
OptionalcontentItemStyle?: {
contentItemDisplayType?: ContentItemDisplayType;
gridStyle?: {
corner?: "rounded" | "straight";
frameColor?: string;
hasFrame?: boolean;
hasShadow?: boolean;
hideFolderCount?: boolean;
thumbnailShape?: "square" | "imageRatio";
titleLength?: "oneLine" | "fullText" | "twoLines";
titleStyle?: "attached" | "detached" | "floating";
titleTextColor?: "light" | "dark";
};
}
OptionalcontentItemDisplayType?: ContentItemDisplayType
OptionalgridStyle?: {
corner?: "rounded" | "straight";
frameColor?: string;
hasFrame?: boolean;
hasShadow?: boolean;
hideFolderCount?: boolean;
thumbnailShape?: "square" | "imageRatio";
titleLength?: "oneLine" | "fullText" | "twoLines";
titleStyle?: "attached" | "detached" | "floating";
titleTextColor?: "light" | "dark";
}
Optionalcorner?: "rounded" | "straight"
OptionalframeColor?: string
OptionalhasFrame?: boolean
OptionalhasShadow?: boolean
OptionalhideFolderCount?: boolean
OptionalthumbnailShape?: "square" | "imageRatio"
OptionaltitleLength?: "oneLine" | "fullText" | "twoLines"
OptionaltitleStyle?: "attached" | "detached" | "floating"
OptionaltitleTextColor?: "light" | "dark"
Optionaldependencies?: (undefined | {
id?: string;
type?: string;
})[]
OptionalhomePageSlug?: string
OptionalinitiallyHideMenus?: boolean
OptionalisTemplate?: boolean
OptionalnavigationBackgroundColor?: string
OptionalnavigationTextColor?: TextColor
OptionaltemplateSlug?: string
OptionaltextColor?: TextColor
Optionalthumbnail?: {
slug?: string;
type?: ImageSourceType;
}
Optionalslug?: string
Optionaltype?: ImageSourceType
Optionaltitle?: string
Optionalmodified?: string
Optionalpages?: (undefined | {
layout?: {
rows?: ((...) | (...))[];
};
metadata?: {
backgroundColor?: string;
backgroundImageFileSlug?: string;
backgroundImageSlug?: string;
backgroundImageXPosition?: XPosition;
backgroundImageYPosition?: YPosition;
backgroundVideoSlug?: string;
backgroundVideoXPosition?: XPosition;
backgroundVideoYPosition?: YPosition;
contentItemStyle?: {
contentItemDisplayType?: (...) | (...);
gridStyle?: (...) | (...);
};
textColor?: TextColor;
title?: string;
type?: WorkspacePageType;
};
slug?: string;
workspaceSlug?: string;
})[]
Optionalpermissions?: (undefined | {
assigneeId?: string;
assigneeName?: string;
assigneeType?: string;
permission?: string;
})[]
Optionalshares?: []
Optionalslug?: string
OptionalthumbnailUrl?: string
Optionaltype?: "Workspace"
OptionalversionTags?: {}
OptionalworkspaceVersion?: string
Returns DeviceApi.Workspace