Documente Academic
Documente Profesional
Documente Cultură
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc
API
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. Copyright 2007 Ektron®, Inc. All rights reserved.
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Parameter Name;
Copyright 2007 Ektron®, Parameter
Inc. All Type; isCode
rights reserved. EKTRON Sample
a registered trademark of Ektron, Inc EKTRON is a registered trademark of Ektron, Inc. Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc
EKTRON is a registered trademark of Ektron, Inc.
Methods DisplayDateCreated string LastEditDate DateTime SitemapInherited integer Methods UserId integer FirstName string definition.
Id integer
UserId integer DisplayLastEditDate string SitemapInheritedFrom integer ActivateUserAccount() boolean UserGroupList string LastName string
AddContent() integer (overloaded) GetSubscriptionPropertiesForContent()
UserName string UserId integer SitemapPath Common.SitemapPath() (overloaded) PermissionType PermissionUserType = UserPreference UserPreferenceData
ContentTitle string PermissionUserType.All (optional) See User Data Classes > UserPreferenceData SubscriptionPropertiesData
ContentComment string FolderId integer EditorFirstName string Title String
UserId integer
Url String PermissionRequest IsMemberShip boolean See Subscription Data Classes > SubscriptionData
ContentHtml string IsInherited boolean EditorLastName string Description String ActivateUserAccount() Boolean Retrieves subscription properties for content using
PermissionRequestType = LoginIdentification string the content's ID.
InheritedFrom integer PhysicalPath string Order Integer
Quick
Quick
SearchText string FolderId Integer (overloaded) PermissionRequestType.All (optional) LanguageName string ContentId integer
SummaryHtml string Status string LogicalPath string Language Integer Username string GetUsers() UserData() (overloaded) LanguageId integer GetSubscriptionPropertiesForFolder()
ContentLanguage string IsPrivate boolean DefaultXslt string ReplicationMethod integer AccountID string See User Data Classes > UserData
GroupId integer IsDisableMessage boolean SubscriptionPropertiesData
FolderId integer GoLive string PackageXslt string IsCommunityFolder boolean Account ID generated when account was created.
AddMembershipUser() UserData OrderBy string Email string See Subscription Data Classes > SubscriptionPropertiesData
GoLive object DisplayGoLive string PackageDisplayXslt string TaxonomyInheritedFrom integer Retrieves subscription properties for a given
See User Data Classes > UserData
GetUsers() UserGroupData() (overloaded) EditorOption string folder ID.
EndDate object ManualAliasId integer DesignStyleSheet string TaxonomyInherited boolean
udUserData UserData See User Data Classes > UserGroupData AdUserName string FolderId integer
MetaInfoXml object ManualAlias string PhysPathComplete object CategoryRequired boolean See User Data Classes > UserData
usernames string GroupId integer GetSubscriptionsForContent()
Sample Code: ApprovalMethod integer LogicalPathComplete object Verifies at least one category assigned when saving Sample Code:
Dim contentApi As New Ektron.Cms.API.Content.Content
content. Dim memDetails As New Ektron.Cms.UserData userNameTypes string = “” (optional) GroupName string SubscriptionData()
IsPublished boolean IsDefault boolean FolderTaxonomy TaxonomyBaseData() Dim userAPI As New Ektron.Cms.API.User.User See Subscription Data Classes > SubscriptionData
Dim ID As Integer = 0 GetUsersForTask() GetUserAttributes CustomAttributeList
ID = contentApi.AddContent("Example Content title", _ Type integer FieldList string See Taxonomy Data Classes > TaxonomyBaseData memDetails.Username = "jsmith" Returns an array of SubscriptionData classes
"Contentadded by AddContent.aspx", "Example HTML", "", _ memDetails.FirstName = "John" CallerID integer IsAccountLocked boolean representing the subscriptions for a given Content
IsSearchable boolean
"", "1033", 0, "", "", Nothing)
IsXmlInherited boolean
Folder Class Ektron.Cms.FolderRequest memDetails.LastName = "Smith"
memDetails.Password = "secret" ContentID integer reqInfo EkRequestInformation ID.
ContentId integer
AddContent() integer (overloaded) FolderId integer IsAdmin() boolean Rank UserRank
In addition to ContentID, this method contains all properties in XmlInheritedFrom integer Ektron.Cms.API.Folder Methods FolderName string
newMemUser = userAPI.AddMembershipUser(memDetails)
AddUser() UserData (overloaded) Avatar string GetSubscriptionsForFolder()
the first AddContent() found above. MetaData ContentMetaData() IsARoleMember() boolean (overloaded)
AddCommunityFolder() FolderDescription string SubscriptionData()
ContentID integer See Content Data Classes > ContentMetaData
request FolderRequest ParentId integer
See User Data Classes > UserData
udUserData UserData
RoleId Ektron.Cms.Common.Ek- Ektron.Cms.UserRequestData See Subscription Data Classes > SubscriptionData
AddContent() integer (overloaded) LegacyData Object The folder's properties as a FolderRequest object. Enumeration.CmsRoleIds Type integer Loads subscriptions for a given folder ID.
TemplateFileName string See User Data Classes > UserData
CreateTask = 1 AdminXmlConfig = 11 FolderId integer
In addition to XmlID and TemplateID, this method contains all Teaser string AddFolder() AddUserToGroup() Group integer
properties in the first AddContent() found above. StyleSheet string RedirectTask = 2 AminCollectionMenu = 12
XmlID integer DisplayEndDate string request FolderRequest SiteMapPathInherit boolean UserId integer DeleteTask = 3
EditAlias = 4
TemplateConfigurations = 13
Personalize = 14
RequiredFlag integer Subscription Data Classes
TemplateID integer EndDate string The folder's properties as a FolderRequest object.
GroupId integer OrderBy string Ektron.Cms.SubscriptionData
Sample Code: SiteMapPath AdminCalendar = 5 AdminPersonalize = 15
CopyContentToFolder() EndDateAction integer Dim folderApi As New Ektron.Cms.API.Folder CreateBlankUserObject() UserData AdminMetadata = 6 PersonalizeEditOnly = 16 SearchText string
Dim req As New Ektron.Cms.FolderRequest
Ektron.Cms.Common.SitemapPath() AdminUsers = 7 PersonalizeMoveOnly = 17 Id integer
Id string XmlConfiguration XmlConfigData req.FolderName = "sample folder"
See SiteMapPath description in FolderData data class (overloaded) AdminFolderUsers = 8 PersonalizeAddOnly = 18 OrderDirection string ID of Subscription Definition
Reference
Reference
FID long
See Content Data Classes > XmlConfigData
req.FolderDescription = "sample description" ImageDirectory string Creates blank UserData object with custom properties. AdminXliff = 9 CollectionApprovers = 19
Ektron.Cms.UserGroupData Name string
Html string req.ParentId = 0 'Adds under the root folder of _
FileDirectory string
See User Data Classes > UserData AdminRuleEditor = 10 AdminChat = 20 Name of Subscription Definition
Lang string IsMetaComplete boolean the workarea CreateBlankUserObject() (overloaded) TaxonomyAdministrator = 21 UserId integer
req.StyleSheet = "" DomainStaging string Enable Boolean
DeleteContentItem() boolean StyleSheet string folderApi.AddFolder(req)
Creates blank UserData object with custom properties. GroupId integer Is it enabled?
Id integer DomainProduction string See User Data Classes > UserData IsARoleMember() boolean (overloaded)
LanguageDescription string DeleteFolderById() boolean udUserData UserData GroupName string LanguageId integer
Sample Code: FolderType integer RoleId Ektron.Cms.Common.Ek-
Dim contentApi As New Ektron.Cms.API.Content.Content Approver string Id integer See User Data Classes > UserData GroupDomain string Language ID code for subscription definition.
IsDomainFolder boolean Enumeration.CmsRoleIds Ektron.Cms.SubscriptionPropertiesData
Dim deleted As Boolean = True
Text string Sample Code: DeleteUserByID() See description in first IsARoleMember() method above. GroupPath string
deleted = contentApi.DeleteContentItem(4) Dim folderApi As New Ektron.Cms.API.Folder XmlInherited boolean BreakInheritance integer
Path string folderApi.DeleteFolderById(24) Id integer nUserId integer IsMemberShipGroup boolean
GetChildContent() ContentData() EnableReplication boolean Inherit from parent?
AssetData GetChildFolders() FolderData DeleteUserFromGroup() GroupFlag boolean = false (optional) GroupDisplayName string 0 = False
See Content Data Classes > ContentData PublishActive string
Id integer Ektron.Cms.Common.AssetData Id integer UserId integer LogInUser() UserData Domain string 1 = True
XmlConfiguration string NotificationType
Recursive boolean = false (optional) ContType integer Recursive Boolean = False (optional) GroupId integer username string UserName string
BreakInheritButton boolean Common.EkEnumeration.SubscriptionPropertyNotificationTy
OrderBy string = “name” (optional) Updates integer OrderBy String = "name" (optional) EditUserCustomProperties() string Password string DisplayUserName string pes
FolderCfldAssignments string
GetContent() Ektron.Cms.Common.ContentResult EditorUserNames string Sample Code: Generates HTML for user’s custom properties.
ServerName string IsMemberShipUser boolean Notification types:
Dim folderApi As New Ektron.Cms.API.Folder SubscriptionProperties UserId integer (optional) Always
(overloaded) FolderName string Dim folders As Ektron.Cms.FolderData() SubscriptionPropertiesData Domain string = “” (optional) Email string Initial
MediaText string Dim folder As Ektron.Cms.FolderData bReadOnly boolean = false (optional) UserCount integer
Req Ektron.Cms.Common.ContentRequest folder = folderApi.GetFolder(24)
See Subscription Data Classes > Protocol string = “” (optional) Never
HistoryId integer SubscriptionPropertiesData GetAllCustomProperties() CustomAttribute() SuspendNextNotification Boolean
Page System.Web.UI.Page = Nothing (optional) folders = folderApi.GetChildFolders(0, True, _
"name") suppressNotification boolean See User Data Classes > CustomAttribute
Sample Code:
Dim userAPI As New Ektron.Cms.API.User.User Ektron.Cms.UserPreferenceData Should we suspend the next notification? For example,
GetContent() ContentData (overloaded) Quicklink string GetAllUserByCustomProperty() UserData() Dim api As New Ektron.Cms.CommonApi Template string for testing.
HyperLink string GetFolder FolderData() (overloaded) ContentSubAssignments string Dim userObj As UserData
See Content Data Classes > ContentData See User Data Classes > UserData
userObj = userAPI.LogInUser("sample name", "sample _ FolderPath string SendNextNotification Boolean
Id integer TemplateConfiguration Id integer MetaInherited integer PropType Should we send the next web alert? Overrides
password", "localhost", "", "")
GetFolder FolderData() (overloaded) MetaInheritedFrom integer DisplayBorders string NotificationTypes: Never and Initial.
Type Ektron.Cms.Content.EkContent.ContentResultType = TemplateData Ektron.Cms.Common.EkEnumeration.Ob- userAPI.SetAuthenticationCookie(userObj)
Id integer TaxonomyInherited boolean Response.Redirect(Request.Url.ToString) DisplayTitleText string Subject string
ContentResultType.Published (optional) Ektron.Cms.ContentEditData jectPropertyValueTypes
Sample Code:
Inherits ContentData GetTaxonomy Boolean TaxonomyInheritedFrom integer String Category ReadCustomProperties() Collection FolderId string URL string
Dim contentApi As New Ektron.Cms.API.Content.Content
Dim contentItem As Ektron.Cms.ContentData NoOfSaves integer GetFolderId() integer (overloaded) CategoryRequired boolean Boolean CategoryProperties form Width integer The URL you are sending from.
contentItem = contentApi.GetContent(22, _ Numeric SelectList
Collections.Specialized.NameValueCollection Height integer EmailFrom string
Ektron.Cms.Content.EkContent.ContentResultType.Published) MaxContentSize integer Id integer TaxonomyIdList string Date MultiSelectList The Email from address.
MaxSummarySize integer Notification ThreadedDiscussion ResetMembershipUserPassword() string ForceSetting boolean
GetContentForEditing() ContentEditData
CurrentStatus string
GetFolderId() integer (overloaded) SiteMap Class PropValues string (overloaded) PageSize integer
FileLocation string
Checks content out and returns its data. FolderName string Where to drop the XML files with the instruction set?
See Content Data Classes > ContentEditData
LockedContentLink boolean ParentId integer Ektron.Cms.API.SiteMap GetAllUserGroups() UserGroupData() Username string Ektron.Cms.CustomAttribute WebLocation string
Id integer (overloaded) ResetMembershipUserPassword() string Where can the Service look to download the XML
GetContentStatus() string
Ektron.Cms.ContentMetaData GetPath() string Methods GroupType (overloaded)
ID string files?
ContentId integer TypeId integer Returns folder path as a string. For example:
GetFolderBreadcrumbPath() Ektron.Cms.Common.EkEnumeration.UserTypes DataID integer OptOutID integer
Text string
\CMS400Demo\AboutUs Username string Name string ID of the OptOut Message (required)
MoveContentToFolder() ContentData Id integer Ektron.Cms.Common.SitemapPath() AuthorType = 1000
AccountId string
TypeName string Indicates CMS Users
Value object DefaultMessageID integer
See Content Data Classes > ContentData RenameFolder() boolean id integer MemberShipType = 2000 SetAuthenticationCookie() ID of the Default Message (optional)
cId string Title string cId integer Use either content ID or folder ID. BothGroupTypes = 3000
See Also: LoginUser()
ValueType CustomAttributeValueTypes SummaryID integer
A comma separated list of content IDs. DefaultText string isFolder boolean = false (optional) OrderBy string userInfo UserData
String
cLanguages string title string Set to True if ID is a folder ID. Otherwise, Boolean
Summary of which content ID?
Required boolean GetAllUserGroups() UserGroupData() See User Data Classes > UserData ContentID integer
Folder Data Classes set to false. Numeric
A comma separated list of language IDs.
FID long TagType string Sample Code: (overloaded) UnsubscribeUser() Boolean Date Use the text of which content ID?
Notification
The Folder ID to which content is be moved. Editable boolean Ektron.Cms.FolderData Dim sitemapApi As New Ektron.Cms.API.SiteMap See User Data Classes > UseGroupData
Username string Category
UseContentTitle string
Dim mapData As _ OrderBy string Not used.
PublishContent() boolean Separater string Id integer Ektron.Cms.Common.SitemapPath() password string = “” (optional) CategoryProperties
UnsubscribeID integer
mapData = _ GetAllUsers() UserGroupData() (overloaded) MultiSelectList
ContentId integer CaseSensitive boolean TemplateId integer sitemapApi.GetFolderBreadcrumbPath(14, True) See User Data Classes > UseGroupData UpdateUser() (overloaded) ThreadedDiscussion ID of the Unsubscribe Message (required)
FolderId integer RemoveDuplicate boolean ParentId integer CallerID integer data UserData Required boolean UseContentLink integer
Card
Card
GetWebsiteMap() WebsiteMap
See User Data Classes > UserData
ContentLanguage integer SearchAllowed boolean NameWithPath string folderId integer = 0 (optional) FolderId integer Language integer Use the content link of which Content ID?
Title string XmlSchema string className string = "ektSitemap" UserId integer Domain string GetAllActiveSubscriptions()
XmlNameSpace string PublishHtmlActive boolean (optional) GetUserGroup() UserGroupData DisplayUserName string
EditorFirstName string SubscriptionData()
Permissions PermissionData Must exist in [site]/workarea/csslib/sitemap.css. See User Data Classes > UserGroupData User’s first and last name. See Subscription Data Classes > SubscriptionData
EditorLastName string UpdatedContent integer maxLevel integer = 0 (optional) Id integer Password string Array of SubscriptionData classes representing all
Comment string TotalContent integer Set to 0 for unlimited. GetUserGroupByName() UserGroupData DisplayName string
active subscriptions.
ektron, Inc. | 542 Amherst Street | Nashua, NH 03063 | Tel: 1-866-4-EKTRON | Fax: (603) 594-0258 | www.ektron.com ektron, Inc. | 542 Amherst Street | Nashua, NH 03063 | Tel: 1-866-4-EKTRON | Fax: (603) 594-0258 | www.ektron.com
What do you want API What do you want API
your website to do? your website to do?
API Quick Reference Quick Reference
Legend: Description or Item List; Method or Property Name; Method or Property Type;
Card Card API
Legend: Description or Item List; Method or Property Name;Quick
Quick
Reference
Method or Property Type;
Reference
Card Card
API
API
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. Copyright 2007 Ektron®, Inc. All rights reserved.
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Parameter Name;
Copyright 2007 Ektron®, Parameter
Inc. All Type; isCode
rights reserved. EKTRON Sample
a registered trademark of Ektron, Inc EKTRON is a registered trademark of Ektron, Inc. Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc
EKTRON is a registered trademark of Ektron, Inc.
Methods DisplayDateCreated string LastEditDate DateTime SitemapInherited integer Methods UserId integer FirstName string definition.
Id integer
UserId integer DisplayLastEditDate string SitemapInheritedFrom integer ActivateUserAccount() boolean UserGroupList string LastName string
AddContent() integer (overloaded) GetSubscriptionPropertiesForContent()
UserName string UserId integer SitemapPath Common.SitemapPath() (overloaded) PermissionType PermissionUserType = UserPreference UserPreferenceData
ContentTitle string PermissionUserType.All (optional) See User Data Classes > UserPreferenceData SubscriptionPropertiesData
ContentComment string FolderId integer EditorFirstName string Title String
UserId integer
Url String PermissionRequest IsMemberShip boolean See Subscription Data Classes > SubscriptionData
ContentHtml string IsInherited boolean EditorLastName string Description String ActivateUserAccount() Boolean Retrieves subscription properties for content using
PermissionRequestType = LoginIdentification string the content's ID.
InheritedFrom integer PhysicalPath string Order Integer
Quick
Quick
SearchText string FolderId Integer (overloaded) PermissionRequestType.All (optional) LanguageName string ContentId integer
SummaryHtml string Status string LogicalPath string Language Integer Username string GetUsers() UserData() (overloaded) LanguageId integer GetSubscriptionPropertiesForFolder()
ContentLanguage string IsPrivate boolean DefaultXslt string ReplicationMethod integer AccountID string See User Data Classes > UserData
GroupId integer IsDisableMessage boolean SubscriptionPropertiesData
FolderId integer GoLive string PackageXslt string IsCommunityFolder boolean Account ID generated when account was created.
AddMembershipUser() UserData OrderBy string Email string See Subscription Data Classes > SubscriptionPropertiesData
GoLive object DisplayGoLive string PackageDisplayXslt string TaxonomyInheritedFrom integer Retrieves subscription properties for a given
See User Data Classes > UserData
GetUsers() UserGroupData() (overloaded) EditorOption string folder ID.
EndDate object ManualAliasId integer DesignStyleSheet string TaxonomyInherited boolean
udUserData UserData See User Data Classes > UserGroupData AdUserName string FolderId integer
MetaInfoXml object ManualAlias string PhysPathComplete object CategoryRequired boolean See User Data Classes > UserData
usernames string GroupId integer GetSubscriptionsForContent()
Sample Code: ApprovalMethod integer LogicalPathComplete object Verifies at least one category assigned when saving Sample Code:
Dim contentApi As New Ektron.Cms.API.Content.Content
content. Dim memDetails As New Ektron.Cms.UserData userNameTypes string = “” (optional) GroupName string SubscriptionData()
IsPublished boolean IsDefault boolean FolderTaxonomy TaxonomyBaseData() Dim userAPI As New Ektron.Cms.API.User.User See Subscription Data Classes > SubscriptionData
Dim ID As Integer = 0 GetUsersForTask() GetUserAttributes CustomAttributeList
ID = contentApi.AddContent("Example Content title", _ Type integer FieldList string See Taxonomy Data Classes > TaxonomyBaseData memDetails.Username = "jsmith" Returns an array of SubscriptionData classes
"Contentadded by AddContent.aspx", "Example HTML", "", _ memDetails.FirstName = "John" CallerID integer IsAccountLocked boolean representing the subscriptions for a given Content
IsSearchable boolean
"", "1033", 0, "", "", Nothing)
IsXmlInherited boolean
Folder Class Ektron.Cms.FolderRequest memDetails.LastName = "Smith"
memDetails.Password = "secret" ContentID integer reqInfo EkRequestInformation ID.
ContentId integer
AddContent() integer (overloaded) FolderId integer IsAdmin() boolean Rank UserRank
In addition to ContentID, this method contains all properties in XmlInheritedFrom integer Ektron.Cms.API.Folder Methods FolderName string
newMemUser = userAPI.AddMembershipUser(memDetails)
AddUser() UserData (overloaded) Avatar string GetSubscriptionsForFolder()
the first AddContent() found above. MetaData ContentMetaData() IsARoleMember() boolean (overloaded)
AddCommunityFolder() FolderDescription string SubscriptionData()
ContentID integer See Content Data Classes > ContentMetaData
request FolderRequest ParentId integer
See User Data Classes > UserData
udUserData UserData
RoleId Ektron.Cms.Common.Ek- Ektron.Cms.UserRequestData See Subscription Data Classes > SubscriptionData
AddContent() integer (overloaded) LegacyData Object The folder's properties as a FolderRequest object. Enumeration.CmsRoleIds Type integer Loads subscriptions for a given folder ID.
TemplateFileName string See User Data Classes > UserData
CreateTask = 1 AdminXmlConfig = 11 FolderId integer
In addition to XmlID and TemplateID, this method contains all Teaser string AddFolder() AddUserToGroup() Group integer
properties in the first AddContent() found above. StyleSheet string RedirectTask = 2 AminCollectionMenu = 12
XmlID integer DisplayEndDate string request FolderRequest SiteMapPathInherit boolean UserId integer DeleteTask = 3
EditAlias = 4
TemplateConfigurations = 13
Personalize = 14
RequiredFlag integer Subscription Data Classes
TemplateID integer EndDate string The folder's properties as a FolderRequest object.
GroupId integer OrderBy string Ektron.Cms.SubscriptionData
Sample Code: SiteMapPath AdminCalendar = 5 AdminPersonalize = 15
CopyContentToFolder() EndDateAction integer Dim folderApi As New Ektron.Cms.API.Folder CreateBlankUserObject() UserData AdminMetadata = 6 PersonalizeEditOnly = 16 SearchText string
Dim req As New Ektron.Cms.FolderRequest
Ektron.Cms.Common.SitemapPath() AdminUsers = 7 PersonalizeMoveOnly = 17 Id integer
Id string XmlConfiguration XmlConfigData req.FolderName = "sample folder"
See SiteMapPath description in FolderData data class (overloaded) AdminFolderUsers = 8 PersonalizeAddOnly = 18 OrderDirection string ID of Subscription Definition
Reference
Reference
FID long
See Content Data Classes > XmlConfigData
req.FolderDescription = "sample description" ImageDirectory string Creates blank UserData object with custom properties. AdminXliff = 9 CollectionApprovers = 19
Ektron.Cms.UserGroupData Name string
Html string req.ParentId = 0 'Adds under the root folder of _
FileDirectory string
See User Data Classes > UserData AdminRuleEditor = 10 AdminChat = 20 Name of Subscription Definition
Lang string IsMetaComplete boolean the workarea CreateBlankUserObject() (overloaded) TaxonomyAdministrator = 21 UserId integer
req.StyleSheet = "" DomainStaging string Enable Boolean
DeleteContentItem() boolean StyleSheet string folderApi.AddFolder(req)
Creates blank UserData object with custom properties. GroupId integer Is it enabled?
Id integer DomainProduction string See User Data Classes > UserData IsARoleMember() boolean (overloaded)
LanguageDescription string DeleteFolderById() boolean udUserData UserData GroupName string LanguageId integer
Sample Code: FolderType integer RoleId Ektron.Cms.Common.Ek-
Dim contentApi As New Ektron.Cms.API.Content.Content Approver string Id integer See User Data Classes > UserData GroupDomain string Language ID code for subscription definition.
IsDomainFolder boolean Enumeration.CmsRoleIds Ektron.Cms.SubscriptionPropertiesData
Dim deleted As Boolean = True
Text string Sample Code: DeleteUserByID() See description in first IsARoleMember() method above. GroupPath string
deleted = contentApi.DeleteContentItem(4) Dim folderApi As New Ektron.Cms.API.Folder XmlInherited boolean BreakInheritance integer
Path string folderApi.DeleteFolderById(24) Id integer nUserId integer IsMemberShipGroup boolean
GetChildContent() ContentData() EnableReplication boolean Inherit from parent?
AssetData GetChildFolders() FolderData DeleteUserFromGroup() GroupFlag boolean = false (optional) GroupDisplayName string 0 = False
See Content Data Classes > ContentData PublishActive string
Id integer Ektron.Cms.Common.AssetData Id integer UserId integer LogInUser() UserData Domain string 1 = True
XmlConfiguration string NotificationType
Recursive boolean = false (optional) ContType integer Recursive Boolean = False (optional) GroupId integer username string UserName string
BreakInheritButton boolean Common.EkEnumeration.SubscriptionPropertyNotificationTy
OrderBy string = “name” (optional) Updates integer OrderBy String = "name" (optional) EditUserCustomProperties() string Password string DisplayUserName string pes
FolderCfldAssignments string
GetContent() Ektron.Cms.Common.ContentResult EditorUserNames string Sample Code: Generates HTML for user’s custom properties.
ServerName string IsMemberShipUser boolean Notification types:
Dim folderApi As New Ektron.Cms.API.Folder SubscriptionProperties UserId integer (optional) Always
(overloaded) FolderName string Dim folders As Ektron.Cms.FolderData() SubscriptionPropertiesData Domain string = “” (optional) Email string Initial
MediaText string Dim folder As Ektron.Cms.FolderData bReadOnly boolean = false (optional) UserCount integer
Req Ektron.Cms.Common.ContentRequest folder = folderApi.GetFolder(24)
See Subscription Data Classes > Protocol string = “” (optional) Never
HistoryId integer SubscriptionPropertiesData GetAllCustomProperties() CustomAttribute() SuspendNextNotification Boolean
Page System.Web.UI.Page = Nothing (optional) folders = folderApi.GetChildFolders(0, True, _
"name") suppressNotification boolean See User Data Classes > CustomAttribute
Sample Code:
Dim userAPI As New Ektron.Cms.API.User.User Ektron.Cms.UserPreferenceData Should we suspend the next notification? For example,
GetContent() ContentData (overloaded) Quicklink string GetAllUserByCustomProperty() UserData() Dim api As New Ektron.Cms.CommonApi Template string for testing.
HyperLink string GetFolder FolderData() (overloaded) ContentSubAssignments string Dim userObj As UserData
See Content Data Classes > ContentData See User Data Classes > UserData
userObj = userAPI.LogInUser("sample name", "sample _ FolderPath string SendNextNotification Boolean
Id integer TemplateConfiguration Id integer MetaInherited integer PropType Should we send the next web alert? Overrides
password", "localhost", "", "")
GetFolder FolderData() (overloaded) MetaInheritedFrom integer DisplayBorders string NotificationTypes: Never and Initial.
Type Ektron.Cms.Content.EkContent.ContentResultType = TemplateData Ektron.Cms.Common.EkEnumeration.Ob- userAPI.SetAuthenticationCookie(userObj)
Id integer TaxonomyInherited boolean Response.Redirect(Request.Url.ToString) DisplayTitleText string Subject string
ContentResultType.Published (optional) Ektron.Cms.ContentEditData jectPropertyValueTypes
Sample Code:
Inherits ContentData GetTaxonomy Boolean TaxonomyInheritedFrom integer String Category ReadCustomProperties() Collection FolderId string URL string
Dim contentApi As New Ektron.Cms.API.Content.Content
Dim contentItem As Ektron.Cms.ContentData NoOfSaves integer GetFolderId() integer (overloaded) CategoryRequired boolean Boolean CategoryProperties form Width integer The URL you are sending from.
contentItem = contentApi.GetContent(22, _ Numeric SelectList
Collections.Specialized.NameValueCollection Height integer EmailFrom string
Ektron.Cms.Content.EkContent.ContentResultType.Published) MaxContentSize integer Id integer TaxonomyIdList string Date MultiSelectList The Email from address.
MaxSummarySize integer Notification ThreadedDiscussion ResetMembershipUserPassword() string ForceSetting boolean
GetContentForEditing() ContentEditData
CurrentStatus string
GetFolderId() integer (overloaded) SiteMap Class PropValues string (overloaded) PageSize integer
FileLocation string
Checks content out and returns its data. FolderName string Where to drop the XML files with the instruction set?
See Content Data Classes > ContentEditData
LockedContentLink boolean ParentId integer Ektron.Cms.API.SiteMap GetAllUserGroups() UserGroupData() Username string Ektron.Cms.CustomAttribute WebLocation string
Id integer (overloaded) ResetMembershipUserPassword() string Where can the Service look to download the XML
GetContentStatus() string
Ektron.Cms.ContentMetaData GetPath() string Methods GroupType (overloaded)
ID string files?
ContentId integer TypeId integer Returns folder path as a string. For example:
GetFolderBreadcrumbPath() Ektron.Cms.Common.EkEnumeration.UserTypes DataID integer OptOutID integer
Text string
\CMS400Demo\AboutUs Username string Name string ID of the OptOut Message (required)
MoveContentToFolder() ContentData Id integer Ektron.Cms.Common.SitemapPath() AuthorType = 1000
AccountId string
TypeName string Indicates CMS Users
Value object DefaultMessageID integer
See Content Data Classes > ContentData RenameFolder() boolean id integer MemberShipType = 2000 SetAuthenticationCookie() ID of the Default Message (optional)
cId string Title string cId integer Use either content ID or folder ID. BothGroupTypes = 3000
See Also: LoginUser()
ValueType CustomAttributeValueTypes SummaryID integer
A comma separated list of content IDs. DefaultText string isFolder boolean = false (optional) OrderBy string userInfo UserData
String
cLanguages string title string Set to True if ID is a folder ID. Otherwise, Boolean
Summary of which content ID?
Required boolean GetAllUserGroups() UserGroupData() See User Data Classes > UserData ContentID integer
Folder Data Classes set to false. Numeric
A comma separated list of language IDs.
FID long TagType string Sample Code: (overloaded) UnsubscribeUser() Boolean Date Use the text of which content ID?
Notification
The Folder ID to which content is be moved. Editable boolean Ektron.Cms.FolderData Dim sitemapApi As New Ektron.Cms.API.SiteMap See User Data Classes > UseGroupData
Username string Category
UseContentTitle string
Dim mapData As _ OrderBy string Not used.
PublishContent() boolean Separater string Id integer Ektron.Cms.Common.SitemapPath() password string = “” (optional) CategoryProperties
UnsubscribeID integer
mapData = _ GetAllUsers() UserGroupData() (overloaded) MultiSelectList
ContentId integer CaseSensitive boolean TemplateId integer sitemapApi.GetFolderBreadcrumbPath(14, True) See User Data Classes > UseGroupData UpdateUser() (overloaded) ThreadedDiscussion ID of the Unsubscribe Message (required)
FolderId integer RemoveDuplicate boolean ParentId integer CallerID integer data UserData Required boolean UseContentLink integer
Card
Card
GetWebsiteMap() WebsiteMap
See User Data Classes > UserData
ContentLanguage integer SearchAllowed boolean NameWithPath string folderId integer = 0 (optional) FolderId integer Language integer Use the content link of which Content ID?
Title string XmlSchema string className string = "ektSitemap" UserId integer Domain string GetAllActiveSubscriptions()
XmlNameSpace string PublishHtmlActive boolean (optional) GetUserGroup() UserGroupData DisplayUserName string
EditorFirstName string SubscriptionData()
Permissions PermissionData Must exist in [site]/workarea/csslib/sitemap.css. See User Data Classes > UserGroupData User’s first and last name. See Subscription Data Classes > SubscriptionData
EditorLastName string UpdatedContent integer maxLevel integer = 0 (optional) Id integer Password string Array of SubscriptionData classes representing all
Comment string TotalContent integer Set to 0 for unlimited. GetUserGroupByName() UserGroupData DisplayName string
active subscriptions.
ektron, Inc. | 542 Amherst Street | Nashua, NH 03063 | Tel: 1-866-4-EKTRON | Fax: (603) 594-0258 | www.ektron.com ektron, Inc. | 542 Amherst Street | Nashua, NH 03063 | Tel: 1-866-4-EKTRON | Fax: (603) 594-0258 | www.ektron.com
API Quick Reference Card API Quick Reference Card
Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample Legend: Description or Item List; Method or Property Name; Method or Property Type; Parameter Name; Parameter Type; Code Sample
Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc Copyright 2007 Ektron®, Inc. All rights reserved. EKTRON is a registered trademark of Ektron, Inc