Struct DocPublished

pub struct DocPublished {
    pub browser_link: String,
    pub categories: Vec<DocCategory>,
    pub description: Option<String>,
    pub discoverable: bool,
    pub earn_credit: bool,
    pub image_link: Option<String>,
    pub mode: DocPublishMode,
}

Information about the publishing state of the document.

JSON schema

{
 "description": "Information about the publishing state of the
document.",
 "type": "object",
 "required": [
   "browserLink",
   "categories",
   "discoverable",
   "earnCredit",
   "mode"
 ],
 "properties": {
   "browserLink": {
     "description": "URL to the published doc.",
     "examples": [
       "https://coda.io/@coda/hello-world"
     ],
     "type": "string"
   },
   "categories": {
     "description": "Categories applied to the doc.",
     "examples": [
       [
         "Project Management"
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/DocCategory"
     }
   },
   "description": {
     "description": "Description of the published doc.",
     "examples": [
       "Hello World!"
     ],
     "type": "string"
   },
   "discoverable": {
     "description": "If true, indicates that the doc is discoverable.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "earnCredit": {
     "description": "If true, new users may be required to sign in to
view content within this document. You will receive Coda credit for each
user who signs up via your doc.\n",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "imageLink": {
     "description": "URL to the cover image for the published doc.",
     "type": "string"
   },
   "mode": {
     "$ref": "#/components/schemas/DocPublishMode"
   }
 },
 "additionalProperties": false,
 "x-schema-name": "DocPublished"
}

Fields

browser_link: String

URL to the published doc.

categories: Vec<DocCategory>

Categories applied to the doc.

description: Option<String>

Description of the published doc.

discoverable: bool

If true, indicates that the doc is discoverable.

earn_credit: bool

If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.

image_link: Option<String>

URL to the cover image for the published doc.

mode: DocPublishMode

Trait Implementations

impl Clone for DocPublished

fn clone(&self) -> DocPublished

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPublished

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocPublished

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&DocPublished> for DocPublished

fn from(value: &DocPublished) -> Self

Converts to this type from the input type.

impl Serialize for DocPublished

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

where __S: Serializer,

Serialize this value into the given Serde serializer.