Struct PageCreate

pub struct PageCreate {
    pub icon_name: Option<String>,
    pub image_url: Option<String>,
    pub name: Option<String>,
    pub page_content: Option<PageCreateContent>,
    pub parent_page_id: Option<String>,
    pub subtitle: Option<String>,
}

Payload for creating a new page in a doc.

JSON schema

{
 "description": "Payload for creating a new page in a doc.",
 "type": "object",
 "properties": {
   "iconName": {
     "description": "Name of the icon.",
     "examples": [
       "rocket"
     ],
     "type": "string"
   },
   "imageUrl": {
     "description": "Url of the cover image to use.",
     "examples": [
       "https://example.com/image.jpg"
     ],
     "type": "string"
   },
   "name": {
     "description": "Name of the page.",
     "examples": [
       "Launch Status"
     ],
     "type": "string"
   },
   "pageContent": {
     "$ref": "#/components/schemas/PageCreateContent"
   },
   "parentPageId": {
     "description": "The ID of this new page's parent, if creating a
subpage.",
     "examples": [
       "canvas-tuVwxYz"
     ],
     "type": "string"
   },
   "subtitle": {
     "description": "Subtitle of the page.",
     "examples": [
       "See the status of launch-related tasks."
     ],
     "type": "string"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "PageCreate"
}

Fields

icon_name: Option<String>

Name of the icon.

image_url: Option<String>

Url of the cover image to use.

name: Option<String>

Name of the page.

page_content: Option<PageCreateContent>

parent_page_id: Option<String>

The ID of this new page’s parent, if creating a subpage.

subtitle: Option<String>

Subtitle of the page.

Trait Implementations

impl Clone for PageCreate

fn clone(&self) -> PageCreate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageCreate

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

Formats the value using the given formatter.

impl Default for PageCreate

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PageCreate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PageCreate> for PageCreate

fn from(value: &PageCreate) -> Self

Converts to this type from the input type.

impl Serialize for PageCreate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.