Struct Page

pub struct Page {

    pub authors: Vec<PersonValue>,
    pub browser_link: String,
    pub children: Vec<PageReference>,
    pub content_type: PageTypeEnum,
    pub created_at: Option<DateTime<Utc>>,
    pub created_by: Option<PersonValue>,
    pub href: String,
    pub icon: Option<Icon>,
    pub id: String,
    pub image: Option<Image>,
    pub is_effectively_hidden: bool,
    pub is_hidden: bool,
    pub name: String,
    pub parent: Option<PageReference>,
    pub subtitle: Option<String>,
    pub type_: PageType,
    pub updated_at: Option<DateTime<Utc>>,
    pub updated_by: Option<PersonValue>,
}

Metadata about a page.

JSON schema

{
 "description": "Metadata about a page.",
 "type": "object",
 "required": [
   "browserLink",
   "children",
   "contentType",
   "href",
   "id",
   "isEffectivelyHidden",
   "isHidden",
   "name",
   "type"
 ],
 "properties": {
   "authors": {
     "description": "Authors of the page",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/PersonValue"
     }
   },
   "browserLink": {
     "description": "Browser-friendly link to the page.",
     "examples": [
       "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO"
     ],
     "type": "string",
     "format": "url"
   },
   "children": {
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/PageReference"
     }
   },
   "contentType": {
     "$ref": "#/components/schemas/PageTypeEnum"
   },
   "createdAt": {
     "description": "Timestamp for when the page was created.",
     "examples": [
       "2018-04-11T00:18:57.946Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "createdBy": {
     "$ref": "#/components/schemas/PersonValue"
   },
   "href": {
     "description": "API link to the page.",
     "examples": [
       "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO"
     ],
     "type": "string",
     "format": "url"
   },
   "icon": {
     "$ref": "#/components/schemas/Icon"
   },
   "id": {
     "description": "ID of the page.",
     "examples": [
       "canvas-IjkLmnO"
     ],
     "type": "string"
   },
   "image": {
     "$ref": "#/components/schemas/Image"
   },
   "isEffectivelyHidden": {
     "description": "Whether the page or any of its parents is hidden in
the UI.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "isHidden": {
     "description": "Whether the page is hidden in the UI.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "name": {
     "description": "Name of the page.",
     "examples": [
       "Launch Status"
     ],
     "type": "string"
   },
   "parent": {
     "$ref": "#/components/schemas/PageReference"
   },
   "subtitle": {
     "description": "Subtitle of the page.",
     "examples": [
       "See the status of launch-related tasks."
     ],
     "type": "string"
   },
   "type": {
     "description": "The type of this resource.",
     "type": "string",
     "enum": [
       "page"
     ],
     "x-tsType": "Type.Page"
   },
   "updatedAt": {
     "description": "Timestamp for when page content was last
modified.",
     "examples": [
       "2018-04-11T00:18:57.946Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "updatedBy": {
     "$ref": "#/components/schemas/PersonValue"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "Page"
}

Fields

authors: Vec<PersonValue>

Authors of the page

browser_link: String

Browser-friendly link to the page.

children: Vec<PageReference>

content_type: PageTypeEnum

created_at: Option<DateTime<Utc>>

Timestamp for when the page was created.

created_by: Option<PersonValue>

href: String

API link to the page.

icon: Option<Icon>

id: String

ID of the page.

image: Option<Image>

is_effectively_hidden: bool

Whether the page or any of its parents is hidden in the UI.

is_hidden: bool

Whether the page is hidden in the UI.

name: String

Name of the page.

parent: Option<PageReference>

subtitle: Option<String>

Subtitle of the page.

type_: PageType

The type of this resource.

updated_at: Option<DateTime<Utc>>

Timestamp for when page content was last modified.

updated_by: Option<PersonValue>

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Page

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Page

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Page> for Page

fn from(value: &Page) -> Self

Converts to this type from the input type.

impl Serialize for Page

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.