ArticleVersionCreateOptions In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:36:40 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:36:40

ArticleVersionCreateOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll

Definition

class ArticleVersionCreateOptions
{
	Guid? ArticleId { get; set;  }
	Guid? CollectionId { get; set;  }
	string MetaDescription { get; set;  }
	string MetaKeywords { get; set;  }
	string MetaTitle { get; set;  }
	DateTime? PublishDate { get; set;  }
	DateTime? PublishEndDate { get; set;  }
	int? PublishGroupId { get; set;  }
	bool? ReadyToPublish { get; set;  }
	bool? SuppressNotifications { get; set;  }
	string Tags { get; set;  }
}

Properties

Name	Type	Description	Default
ArticleId	`Guid?`	Id of the article to create a new article version for. Either ArticleId or CollectionId must be provided.
CollectionId	`Guid?`	Id of the collection to create a new article in. Either ArticleId or CollectionId must be provided.
MetaDescription	`string`	A short description placed in the description meta tag of the page for search engine optimization.
MetaKeywords	`string`	A comma-separated list of tags placed in the keywords meta tag of the page for search engine optimization. If not specified tags will be used if tags are specified.
MetaTitle	`string`	A title used in the meta tag of the page for search engine optimization.
PublishDate	`DateTime?`	Specifies when the article version should be published. Cannot be set if the article version is part of a publish group. Will not publish autormatically unlese ReadyToPublish is true.
PublishEndDate	`DateTime?`	Specifies when to unplublish an article. Will automatically unpublish a published article.
PublishGroupId	`int?`	Specifies a publish group the article version belongs to. When a publish group is specified, the publish date cannot be set. The publish date comes from the publish group.
ReadyToPublish	`bool?`	Specifies whether or not to publish the article version. If not ready to publish, the version will be editable, the article will not be searchable nor viewable by users who can not manage the article collection until after the version is published. Optional parameter	False
SuppressNotifications	`bool?`	Allows suppressing notifications when publishing articles	False
Tags	`string`	A comma separated list of tags