Content Class

This section describes the Web Service methods used with content. The Content Web service is a wrapper for the Content API: Ektron.Cms.API.Content.Content. These methods can be accessed through the Content.asmx file located in:

~/Workarea/webservices/WebServiceAPI/Content/Content.asmx

Web Services examples involving content are available in the Developer sample site. You can download this site from:

http://www.ektron.com/cms400-web-cms.aspx?id=5278

Once the developer site is installed, example code files are located in your site root. For example:

C:\Inetpub\wwwroot\CMS400Developer\Developer\dotNetAssemblies\WebServicesAPI\ContentAPI\Content

IMPORTANT: If you are accessing these Web Services remotely, you will need to set the authentication header. For example:

 wscontentApi.AuthenticationHeaderValue = New localhost.AuthenticationHeader()
wscontentApi.AuthenticationHeaderValue.Username = "admin"
wscontentApi.AuthenticationHeaderValue.Password = "admin"
wscontentApi.AuthenticationHeaderValue.Domain = "Domain" '''Only needed if AD/LDAP is being used

Class Hierarchy

public class Content : EktronBaseService;

Visual Basic

Public Class Content
Inherits EktronBaseService

File

Content.cs

Description

[WebService(Namespace = "http://ektron.com/webservices/")] [WebServiceBinding(ConformsTo = WsiProfiles.None)]

Group

Classes

Topics

Name	Description
Content Methods	The methods of the Content class are listed here.

Content Methods

	Name	Description
	AddContent	This is the overview for the AddContent method overload.
	CheckOutContent	This will check the content out to the current user if the content is currently checked in and the user has privileges to check it out. This method can be accessed through the Content.asmx file located in:
	CopyContentToFolder	Copy the content into required folder. This method can be accessed through the Content.asmx file located in:
	DeleteContentItem	Delete the content by the content's ID. This method can be accessed through the Content.asmx file located in:
	GetAddViewLanguage	Loads all the languages from the system for a given content ID and populates the Add/View drop down box with flag set on each item. This method can be accessed through the Content.asmx file located in:
	GetAllComments	Loads all of the comments. This method can be accessed through the Content.asmx file located in:
	GetAllTemplates	Loads all of the templates. This method can be accessed through the Content.asmx file located in:
	GetAllUnassignedItemApprovals	Returns all of the unassigned user/groups for a given content ID. This method can be accessed through the Content.asmx file located in:
	GetChildContent	This is the overview for the GetChildContent method overload.
	GetContent	Get Content By ID. This method can be accessed through the Content.asmx file located in:
	GetContentByHistory	Retrieves the corresponding content by the history ID. This method can be accessed through the Content.asmx file located in:
	GetContentForEditing	Loads the content details with checkout mode. This method can be accessed through the Content.asmx file located in:
	GetContentState	Loads the content's details. This method can be accessed through the Content.asmx file located in:
	GetContentStatus	This will return a single letter string which is the status of the piece of content. The letters returned are the same letters used in the Workarea view. This method can be accessed through the Content.asmx file located in:
	GetDomain	Gets web domain for a piece of content. This method can be accessed through the Content.asmx file located in:
	MoveContentToFolder	Moves content to a folder. This method can be accessed through the Content.asmx file located in:
	PublishContent	Function takes in information about the content to be checked in and published. This goes through the normal approval chain. The content must be in a checked out state to the current logged in user for this to succeed. This method can be accessed through the Content.asmx file located in:
	RenameContent	Renames the content. This method can be accessed through the Content.asmx file located in:
	SaveContent	Updates the checked out content block. Only following properties can be updated: contentData.Title contentData.Teaser contentData.Comment contentData.GoLive contentData.Html contentData.EndDate contentData.EndDateAction contentData.ManualAlias This method can be accessed through the Content.asmx file located in:
	SubmitForDelete	Delete the content by the content's ID and folder ID. This method can be accessed through the Content.asmx file located in:
	UndoCheckout	This undoes the checkout for a piece of content which is checked out to the current user. This method can be accessed through the Content.asmx file located in:
	UpdateContentMetaData	Updates a specific metadata item attached to a specified piece of content. This method can be accessed through the Content.asmx file located in:

Links

Content Methods, Classes, Legend, Members, Topics, Content Methods

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!