Sunteți pe pagina 1din 4

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

Quicklink string EventLongDescription() string


SearchManager Class
Sample Code:
GetBlogData() BlogData (overloaded) CategoryID integer
Search based on taxonomy category. In this example we search
for the category of Manchester. Title string Calendar() CalendarData
Asset Class See Blog Data Classes > BlogData The ID of the Category metadata definition. Taxonomy Data Classes
Ektron.Cms.API.Search.SearchManager Dim resultCount As Integer
Dim result() As SearchResponseData = _
Address string See Calendar Data Classes > CalendarData Ektron.Cms.API.Content.Asset folder_data FolderData Message string Ektron.Cms.TaxonomyData
Methods search.Search(requestData, HttpContext.Current, _ Description string Ektron.Cms.CalendarData Methods
See Folder Data Classes > FolderData
If you have a folder data class with a folder type blog and
Mask for base.html; the contents of the post.
Comments BlogComment()
Inherits TaxonomyBaseData
resultCount)
MapCategories string AvailableLanguages LanguageData() need to get the blog information, pass the folder data to this
See Blog Data Classes > BlogComment
TaxonomyItems TaxonomyItemData()
Execute ContentData() (overloaded) Dim search As SearchManager = New SearchManager() GetViewUrl() string method and get the populated blogdata back. See Taxonomy Data Classes > TaxonomyItemData
Dim requestData As SearchRequestData = New _ MapTime DateTime CalendarID integer GetBlogData() BlogData (overloaded)
Array of blog comments.
Use this method with the deprecated version of Search.
SearchRequestData()
Returns the URL for an asset.
PostID integer Taxonomy TaxonomyData()
It does not work with WebSearch.
condition Ektron.Cms.ContentSearchCondition
requestData.SearchFor = _ Calendar Class CalendarTitle string AssetId string (required)
ContentType integer
See Blog Data Classes > BlogData
BlogID integer
The ID of the post. TaxonomyXml string
Ektron.Cms.WebSearch.SearchDocumentType.all CalendarDescription string
Sample Code: requestData.GroupBy = "taxCategory" Ektron.Cms.API.Calendar.Calendar Get a blog for a given ID, returns all posts. Ektron.Cms.BlogRoll Ektron.Cms.TaxonomyBaseData
Dim isEnglish As ContentSearchCondition = New _
ContentSearchCondition
requestData.SearchText = "Manchester"
Dim resultCount As Integer Methods
RootFolderID integer
RootFolderPath string
Asset Data Class GetBlogData() BlogData (overloaded) Items BlogRollItem TaxonomyId integer
TaxonomyName string
Ektron.Cms.Common.AssetData
isEnglish.setType = SearchType.EQUAL Dim result() As String = _ See Blog Data Classes > BlogData Array of blog roll links.
isEnglish.setValue = 1033 search.SearchForCategories(requestData, _ CreateLangArrayFromCSlist() Read only. Gets all posts for a given ID and a given date. See Blog Data Classes > BlogRollItem
ShowWeekend boolean TaxonomyLanguage integer
isEnglish.setVariable = Content.content_language HttpContext.Current, 0, 0, resultCount) LanguageData() Id String BlogID integer ID integer
Dim isTitleLikeTest As ContentSearchCondition = New _
SearchTable DataSet TableHeight integer TaxonomyLanguageName string
ContentSearchCondition inList string Version String StartDate DateTime ID of the Blog.
isTitleLikeTest.setType = SearchType.LIKE searchReqData SearchRequestData TableHeight is deprecated.
RollItem BlogRollItem TaxonomyDescription string
DeleteCalendar() boolean TableWidth() integer MimeType As String GetBlogData() BlogData (overloaded)
isTitleLikeTest.setValue = "test" See Search Data Classes > SearchRequestData See Blog Data Classes > BlogData Property to obtain a specific blogroll link. TaxonomyParentId integer
isTitleLikeTest.setVariable = Content.content_title
searchParams string id integer LocationLabel string MimeName String See Blog Data Classes > BlogRollItem
Dim condition As ContentSearchCondition = New _ Sample Code: BlogID integer TaxonomyLevel integer
ContentSearchCondition context HttpContext Dim calendarApi As New _ StartLabel string FileName String index integer TaxonomyPath string
StartDate DateTime
condition.setType = SearchType.AND
resultCount integer Ektron.Cms.API.Calendar.Calendar
EndLabel string FileExtension Date to get posts from. Length integer TaxonomyCreatedDate DateTime
condition.AddCondition(isTitleLikeTest) Dim deleted As Boolean = True
condition.AddCondition(isEnglish) # of records returned deleted = calendarApi.DeleteCalendar(4) ForwardOnly Boolean ImageUrl String Postvisible integer
Number of blog roll links.
TaxonomyItemCount integer
Dim search As New SearchManager
Dim result As ContentData() = search.Execute(condition) WebSearch Data Classes GetAllCalendars() CalendarData() Only display event this day and forward. Icon String # of posts to return.
0 (zero) = no limit
Ektron.Cms.BlogRollItem TaxonomyHasChildren boolean
See Calendar Data Classes > CalendarData EventTypeLabel string Status String LinkName string
Execute UserData() (overloaded) Ektron.Cms.WebSearch.SearchData.SearchRequestData -1 = all posts for the day are shown Ektron.Cms.TaxonomyItemData
Use this method with the deprecated version of Search. GetCalendar() CalendarData EventTypeAvailable string Language String -2 = all posts for the month are shown Name of link.
It does not work with WebSearch. SearchText string See Calendar Data Classes > CalendarData
EventTypeRequired boolean Type Integer -3 = uses the # of Post Visible from the Workarea URL string TaxonomyId integer
condition Ektron.Cms.UserSearchCondition Text for which to search. Defaults to blank. CalendarID integer ContentLanguage integer LanguageID integer URL of blog roll link. TaxonomyLanguage integer
MaxResults integer PluginType String
Sample Code: Sample Code: GetBlogDataForPost() BlogData ShortDescription string TaxonomyItemId integer
Dim isMemberShip As UserSearchCondition = New _ Maximum number of results returned if paging not enabled. Dim calendarApi As New _ LongDescriptionAvailable integer PublishPdfActive Boolean = False A quick description of the link.
Ektron.Cms.API.Calendar.Calendar Allowed to have long description for events in the
See Blog Data Classes > BlogData TaxonomyItemLanguage integer
Blog Class
UserSearchCondition Defaults to 250.
Dim cData As New Ektron.Cms.Common.CalendarData calendar.
Obtains blog information for a given post ID. Relationship string TaxonomyItemType integer
isMemberShip.setType = SearchType.EQUAL
isMemberShip.setValue = 1
FolderID integer cData = calendarApi.GetCalendar(4) 0 = not allowed post_id integer XFN relationship value.
isMemberShip.setVariable = Users.membership_user
FolderID from which search should start. Default folder is 0.
GetFolderWithChildren() FolderData 1 = Text only Ektron.Cms.API.Content.Blog GetBlogPostData() ID integer TaxonomyItemType integer
Dim isInEktron As UserSearchCondition = New _ Recursive boolean See Folder Data Classes > FolderData 2 = Rich Text (HTML) Returns post information for a given post ID. Returns ID of blog roll entry. TaxonomyItemAddedUser integer
UserSearchCondition Is search recursive or limited to specified folder? Default is LongDescriptionAvailableText string Methods
inFolderID integer
Taxonomy Class TaxonomyItemTitle string
tags, trackback, pingback, and categories for post.
isInEktron.setType = SearchType.EQUAL recursive.
isInEktron.setValue = "03031" SaveCalendar() integer
String value of LongDescriptionAvailable property.
AddBlog() integer id integer TaxonomyItemTeaser string
OrderBy string EventTypeInstructions string
isInEktron.setVariable = "zip"
Order search results by specified column. Defaults to Rank. inCalendar CalendarData Gets text displayed next to event type selector.
ParentFolderID integer GetBlogRoll() integer (overloaded) Ektron.Cms.API.Content.Taxonomy TaxonomyItemQuickLink string
Dim condition As UserSearchCondition = New _ Returns blog roll for a given blog ID.
UserSearchCondition OrderDirection string See Calendar Data Classes > CalendarData
ShowAllEventTypes string
Folder ID where blog will be created. Methods TaxonomyItemAssetInfo
condition.setType = SearchType.AND Order by ascending or descending. Defaults to Descending. Sample Code: BlogName string blog_id integer
Dim calendarApi As New _ Gets text displayed to “show all” events in the AddTaxonomyItem() (overloaded) Ektron.Cms.Common.AssetData
condition.AddCondition(isInEktron)
CurrentPage Ektron.Cms.API.Calendar.Calendar event type selector. Name of blog. GetBlogRoll() string (overloaded)
condition.AddCondition(isMemberShip)
BlogTitle string Returns blog roll for a given blog path.
Use to assign one content block to several TaxonomyItemEditorLastName string
Dim cData As New Ektron.Cms.CalendarData
Analytics Class
Dim search As New SearchManager Used for paging through results. categories.
Dim result As UserData() = search.Execute(condition) SearchReturnType Dim id As Integer = 0 Title of blog. Path string request TaxonomyContentRequest TaxonomyItemEditorFirstName string
cData.CalendarID = 0 ‘leave 0 to add new BlogDescription string TaxonomyItemDisplayDateModified
Search MapResponseData() (overloaded) Defaults to HTML (html, datatable or xml).
cData.CalendarTitle = “Example Calendar” Ektron.Cms.API.Analytics.Analytics GetPost() ContentData See Taxonomy Data Classes >
mapReqData MapRequestData LanguageID integer cData.CalendarDescription = “Example Calendar” Visibility Ektron.Cms.Common.EkEnumeration.BlogVisibility See Content Data Classes > ContentData TaxonomyContentRequest string
Language of contents to be searched. Defaults to 1033 cData.RootFolderID = 0 Methods Is blog visible to public or restricted? Returns ContentData class for a given post ID and a AddTaxonomyItem() (overloaded) Ektron.Cms.TaxonomyFolderSyncData
context HttpContext (English). cData.ShowWeekend = True Public BlogPostData class. Use when several content blocks are
GetSessionRank() integer
index integer PageSize cData.EventTypeAvailable = True
0 = first page a new user has visited
Private post_id integer assigned one particular category. TaxonomyId integer
cData.EventTypeRequired = False EnableComments boolean request TaxonomyRequest
page number Defaults to providerPageSize.
id = calendarApi.SaveCalendar(cData) 1 = first page a returning user has visited PostInfo BlogPostData TaxonomyLanguage integer
count integer Weights 2 = any other page Is commenting enabled?
GetPostbyID() BlogPostData
See Taxonomy Data Classes >
FolderId integer
page size Used for weighted word search. This is specific to the CalendarEvent Class page System.Web.UI.Page ModerateComments boolean See Blog Data Classes > BlogPostData
TaxonomyRequest
AddTaxonomySyncFolder() FolderTitle string
resultCount integer IndexService Sample Code: Are comments moderated? Returns a BlogPostData class for a given post ID.
SearchType string Ektron.Cms.API.Calendar.CalendarEvent Dim AnalyticsAPI As New _ RequireAuthentication boolean Once data is created using this method, it Ektron.Cms.TaxonomyItemRequest
# of records returned
Ektron.Cms.API.Analytics.Analytics post_id integer
Sample Code: Type of search to perform. Defaults to “and” Methods Do comments require authentication?
watches the folder for auto entries to this category
Inherits TaxonomyItemBaseRequest
The example demonstrates how to retrieve geo-content from
CMS400.Net.
none
and DeleteEvent()
Dim session_rank As Integer = _
AnalyticsAPI.GetSessionRank(Me.Page) Categories string Blog Data Classes when adding or editing the content block.
request TaxonomySyncRequest TaxonomyItemList integer
Response.Write(session_rank) Array of categories for blog. TaxonomyItemLanguage integer
Dim search As SearchManager = New SearchManager()
Dim requestData As MapRequestData = New MapRequestData()
or
andnot
eventID integer HardDumpAnalyticsBuffer() RollLinks BlogRoll Ektron.Cms.BlogComment See Taxonomy Data Classes >
TaxonomySyncRequest TaxonomyItemType integer
Dim index As Integer = 1 near LoadEvent() CalendarEventData Forces analytics buffer to write to database. A list of links for the blog. Title string CreateTaxonomy() integer
Dim pageSize As Integer = 10 weighted eventID integer Surpasses checks to see if time before AddCommentForPost() boolean Ektron.Cms.TaxonomyContentRequest
requestData.LanguageID = 1033
SearchFor string write or number of records before write has passed. DisplayName string request TaxonomyData
Dim meta As MetaData = New MetaData() Sample Code: Adds a blog post comment. Display name of the user who posted comment (if applicable). ContentId integer
Type of content to search. By default, all are searched. Dim calendarApi As New _ QueryAnalytics() DataSet bcComment BlogComment
See Taxonomy Data Classes > TaxonomyData
meta.MetaDataValue = -71.495246887207
all Ektron.Cms.API.Calendar.CalendarEvent Email string DeleteTaxonomy() TaxonomyList string
meta.MetaDataValue2 = 71.6737747192383
Dim cData As New Ektron.Cms.CalendarEventData selectCommands() string See Blog Data Classes > BlogComment
meta.Operator = MetaOperator.and html Email address of user who posted comment.
request TaxonomyRequest Ektron.Cms.TaxonomyRequest
meta.DataComparer = MetaComparer.range documents cData = calendarAPI.LoadEvent(1) array of SQL queries in string format AddPost() integer URI string Inherits TaxonomyBaseRequest
meta.MetaName = "MapLongitude" images SaveEvent() Integer SoftDumpAnalyticsBuffer() boolean blogID integer Website of user who posted comment.
See Taxonomy Data Classes >
Dim meta2 As MetaData = New MetaData() multimedia Writes analytics buffer to database only if
TaxonomyRequest SearchText string
CalEvent ID of blog to which post is added. Message string GetTaxonomyIdByPath() integer TaxonomyIdList string
meta2.MetaDataValue = 42.7437345034087 UserId integer TimeBeforeWrite or HitsBeforeWrite conditions
PostContent ContentData
meta2.MetaDataValue2 = 42.8747061062372 User ID on which to filter private documents. Ektron.Cms.CalendarEventData are surpassed. The text of the comment. Returns the taxonomy by its path.
FolderId integer
meta2.Operator = MetaOperator.and
EnablePaging boolean See Calendar Data Classes > CalendarEventData TrackVisit() (overloaded) A content data class representing the post. ID integer Note: This is not a CMS400.NET folder path, it
meta2.DataComparer = MetaComparer.range
associatedIDs String = "" (optional) Same as TrackVisit(Page), but does not
See Content Data Classes > ContentData ID of comment. is the taxonomy path. For example: TaxonomyItemType integer
meta2.MetaName = "MapLatitude" Do you want to get paged results?
By default, paging is enabled and page size set to 10. Only for reoccuring events. Updates all automatically pull information from a Page object, Categories string DateCreated DateTime
\MapCategory\Restaurant\American
IncludeItems boolean
requestData.MetaDataNameList = New MetaData() {meta,
pass those values down yourself. An array of categories for post. path string
meta2} Modify provider settings in web.config to modify page size. reoccuring events with event data.
Pingback boolean PostID integer Depth integer
content_id integer Sample Code:
Category string
Calendar Data Classes
Dim resultCount As Integer ID of post for the comment.
Dim result() As MapResponseData = _ user_id integer Tags string
Dim TaxAPI As New _ Preview boolean
search.Search(requestData, HttpContext.Current, index, _
Taxanomy category for which to search. Defaults to blank.
ProviderName string Ektron.Cms.BlogData Ektron.Cms.API.Content.Taxonomy
Dim TaxID As Integer ReadCount boolean
Ektron.Cms.CalendarEventData
CMS user or Membership user ID. 0 = visitor String list of tags for this post.
pageSize, resultCount)
Search SearchResponseData() (overloaded) Index Service provider to use. Defaults to Dialect2 provider. visitor_id string TrackbackURL string Inherits FolderData TaxID = _
TaxAPI.GetTaxonomyIdByPath("\MapCategory")
Page System.Web.UI.Page
Can be changed in Web.config. EventID integer session_rank integer URL for which to trackback. BlogID integer Response.Write(TaxID) Ektron.Cms.TaxonomyItemBaseRequest
searchReqData SearchRequestData GroupBy string DeleteBlog() Content BlogPostData()
EventTitle string 0 = first page a new user has visited ImportTaxonomy() integer Inherits TaxonomyBaseRequest
context HttpContext Only Dialect provider supports this GroupBy column name. 1 = first page a returning user has visited Deletes blog and all associated comments and posts. See Blog Data Classes > BlogPostData
CalendarID integer TaxonomyXml string Ektron.Cms.TaxonomySyncRequest
resultCount integer Note: Ranking is altered if you do group by. 2 = any other page BlogID integer Posts of the blog.
# of records returned Ektron.Cms.WebSearch.SearchData.MapRequestData EventLocation string referring_url string ID of blog to be deleted. Visibility Ektron.Cms.Common.EkEnumeration.BlogVisibility Title string Inherits TaxonomyBaseRequest

EventDay integer LoadTaxonomy() TaxonomyData SyncIdList string


Sample Code: Inherits from SearchRequestData url string Sample Code:
Dim BlogAPI As New Ektron.Cms.API.Content.Blog
Public
The example demonstrates how to retrieve content that contains
CurrentLongitude integer EventMonth integer Private See Taxonomy Data Classes > TaxonomyData SyncRecursiveIdList string
“research” and has a searchable metadata “wellness” set to “Cancer”. TrackVisit() (overloaded) BlogAPI.DeleteBlog(202)
Title string
Dim search As SearchManager = New SearchManager() CurrentLatitude integer EventYear integer Tracks a visit and passes down viewed content DeletePost() boolean request TaxonomyRequest Ektron.Cms.TaxonomyBaseRequest
Dim requestData As SearchRequestData = New _
Ektron.Cms.WebSearch.SearchData.MapRequestData EventDescription string ID. It automatically pulls user_id, visitor_id,
Deletes post and all associated comments.
Tagline string See Taxonomy Data Classes > Inherits SortRequest
SearchRequestData() session_rank, referring_url and URL from the page TaxonomyRequest
EventStartTime Date post_id integer PostsVisible integer TaxonomyId integer
requestData.LanguageID = 1033 Characterization string object. ReadAllAssignedCategory()
requestData.SearchText = "research"
EventStartTimeDisplay string page System.Web.UI.Page ID of post to be deleted. Number of posts to appear on blog. Can be overridden TaxonomyLanguage integer
Dim meta As MetaData = New MetaData() DateCreated DateTime GetBlankBlogPostData() BlogPostData
on the server control. TaxonomyBaseData()
EventShowStartTime boolean content_id integer EnableComments boolean See Taxonomy Data Classes > Ektron.Cms.SortRequest
meta.MetaDataValue = "Cancer"
meta.DataComparer = MetaComparer.equalTo
DateModified DateTime See Blog Data Classes > BlogPostData TaxonomyBaseData Inherits PageRequestData
ContentID integer Display start time in the calendar output.
Ektron.Cms.API.Analytics.Analytics Get a populated blogpostdata class with the trackback, ping, ModerateComments boolean contentid integer
meta.MetaName = "wellness"
EventEndTime Date tags and categories definition IDs. A utility function for the Are comments moderated? SortOrder string
requestData.MetaDataNameList = New MetaData() {meta}
Dim resultCount As Integer
ContentLanguage integer
EventEndTimeDisplay String Properties CMS.
RequiresAuthentication boolean ReadTaxonomy() TaxonomyData SortDirection string
Dim result() As SearchResponseData = FolderID integer AnalyticsEnabled boolean GetBlog() BlogData (overloaded) Is authentication required to post comments? See Taxonomy Data Classes > TaxonomyData
Ektron.Cms.TaxonomyLanguageRequest
search.Search(requestData, HttpContext.Current, _ EventShowEndTime boolean request TaxonomyRequest
resultCount)
ContentType integer Display end time in the calendar output. Read only boolean value from web.config indicating Use a blog’s ID to get the blog.
NotifyURL string TaxonomyId integer
See Blog Data Classes > BlogData See Taxonomy Data Classes >
Search SearchResponseData() (overloaded) QuickLink string ContentID integer
whether or not analytics is enabled.
ID integer
URLs to notify when posts are added.
TaxonomyRequest IsTranslated boolean
Summary string AppendToIISLog boolean Categories string()
searchText string ContentLanguage integer Read only Boolean value from web.config Blog ID
Array of categories for the blog.
RemoveTaxonomyFolder() Ektron.Cms.MapCategoryData
context HttpContext LastAuthor string QLink string indicating whether or not content ID and user ID of StartDate string request TaxonomySyncRequest
BlogRoll BlogRoll CategoryId integer
resultCount integer Title string Quicklink of the associated content or a specified each visit is appended to the IIS logs. The date from which to get posts.
The blog’s roll. See Taxonomy Data Classes >
Size long hyperlink. InMemoryContentHitsData MaxEntries integer See Blog Data Classes > BlogRoll TaxonomySyncRequest CategoryTitle string
# of records returned
LaunchNewBrowser boolean ContentHitsData # of posts to return. RemoveTaxonomyItem() CategoryPath string
SearchForCategories string() Category string
AuthorLastName string A shared (static) strongly typed dataset containing 0 = no limit Ektron.Cms.BlogPostData request TaxonomyRequest ParentId integer
searchReqData SearchRequestData FileImage string all tracking information. This should not be -1 = all posts for the day are shown
TrackBackURL string
See Search Data Classes > SearchRequestData AuthorFirstName string manipulated directly. -2 = all posts for the month are shown See Taxonomy Data Classes > HasChildren boolean
Ektron.Cms.WebSearch.SearchData.MapResponseData -3 = use the # of Post Visible from the Workarea The URL(s) for which to trackback.
TaxonomyRequest
context HttpContext EventRecursionID integer RecordsBeforeWrite integer ReOrderTaxonomyItems() Category MapCategoryData()
Longitude double Read only. LanguageID integer Tags string
index integer Indicates number of records to hold in static
request TaxonomyRequest
page number Distance double 0 = event is not reoccurring. Otherwise, it returns memory buffer before writing to database. This GetBlog() BlogData (overloaded) Tags for the post.
shared ID for all recursions of the event. See Taxonomy Data Classes >
count integer Latitude double smoothes out the number of writes to database. Use a blog’s folder path to get the blog. Pingback boolean
EventRecursionType() TimeBeforeWrite integer See Blog Data Classes > BlogData The URL(s) to pingback when the post is published.
TaxonomyRequest
page size MetaInfo string CalendarEventAPI.RecursionType path string UpdateTaxonomy()
resultCount integer
Indicates number of seconds before writing in- Categories string()
Summary string Public Enum RecursionType memory buffer of records to database. This Folder path to the blog. request TaxonomyData
# of records returned smoothes out the number of writes to database. TrackBackURLID integer
See Sample for this method at top of next column.
Daily = 0 StartDate string The ID of the Trackback metadata definition.
See Taxonomy Data Classes > TaxonomyData
Weekly = 1 The date from which to get posts.
MonthlyByDay = 2 TagsID integer
MonthlyByWeekday = 3 MaxEntries integer The ID of the Tags metadata definition.
YearlyByMonthDay = 4 See above MaxEntries description from first GetBlogData().
PingBackID integer
YearlyByMonthWeekDay = 5 LanguageID integer The ID of the Pingback metadata definition.
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.

GetUserPermissions() AcceptedTerms boolean GetSubscription() SubscriptionData


Content Class LastEditDate string XmlAdvConfig string DomainStaging string User Class Id integer Id integer See Subscription Data Classes > SubscriptionData
DisplayLastEditDate string DateCreated string DomainProduction string
Ektron.Cms.API.Content.Content DateCreated DateTime DisplayDateCreated string FolderType integer Ektron.Cms.API.User.User ItemType string Username string
For a given ID, returns a SubscriptionData class
populated with settings for that Subscription

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?

dontCreateTask string MetaDisplay boolean UpDateUserGroup() (overloaded) TagType integer Ektron.Cms.EmailFromData


Name string getSameLevelNodes boolean = false GetAllUsers() UserGroupData() (overloaded)
UserID integer Language integer data UserData IsList boolean Class representing the emails from which a subscription is
Description string (optional) See User Data Classes > UseGroupData
See User Data Classes > UserData sent.
TaskTitle string SelectableText string Inherited boolean True = include all sites at same level as folderId userRequest UserRequestData IsDisplayedInEktronExplorer boolean Id integer
Sample Code: See User Data Classes > UseRequestData UserObject() UserData (overloaded)
SaveContent() boolean AllowMulti boolean InheritedFrom integer Dim sitemapApi As New Ektron.Cms.API.SiteMap See User Data Classes > UserData DoesAtrributeExist boolean Email string
GetGroupsUserIsIn() GroupData()
contentEditData ContentEditData IsSelectableOnly boolean PrivateContent boolean Dim mapData As Ektron.Cms.Common.WebsiteMap Id integer Ektron.Cms.GroupData Ektron.Cms.EmailMessageData
mapData = sitemapApi.GetWebsiteMap(14, False) UserId integer
See Content Data Classes > ContentEditData MetaDisplayEE boolean XmlInherited boolean UserObject() UserData (overloaded) Class representing Subscription Email messages.
UndoCheckout() boolean RenderFolderBreadcrumbHtml() string OrderBy string See User Data Classes > UserData GroupPath string
IsMetadataBlog boolean XmlInheritedFrom integer GroupID DisplayGroupName string Id integer
ContentId integer nodes() Ektron.Cms.Common.SitemapPath sUserName string
BlogMetaType integer XmlConfiguration XmlConfigData() Title String
GroupName
GroupId integer Title string
UpdateContentMetaData() boolean Ektron.Cms.XmlConfigData See Content Data Classes > XmlConfigData Url String GetMembershipUser() UserData Ektron.Cms.API.User.User GroupName string
Title of the Subscription message.
ContentID integer StyleSheet string Description String See User Data Classes > UserData Text string
MetaID integer
Id integer
TemplateFileName string
Order Integer Username string Properties GroupDomain string Text of the message.
Title string FolderId Integer
GetUserByUserName() UserData UserIdAuthenticated integer AdGroupName string LanguageId integer
MetaText string Description string StyleSheetInherited boolean Language Integer
Note: Ad stands for Active Directory Language ID code of the message.
User Data Classes
See User Data Classes > UserData
TemplateInherited boolean pathSeparator string
Content Data Classes EditXslt string
ApprovalMethod integer linkNodes boolean
Gets the user by their user name.
Username string
AdGroupDomain string Type Common.EkEnumeration.EmailMessageTypes
What type of message is it?
Ektron.Cms.ContentData SaveXslt string
ChildFolders FolderData() linkTarget string Sample Code: Ektron.Cms.UserData Note: Ad stands for Active Directory
IsMemberShipGroup boolean 0 - OptOut
Image string Xslt1 string displayVertical boolean Dim userAPI As New Ektron.Cms.API.User.User Inherits CMSObject 1 - Unsubscribe
MetaInheritedFrom integer
ImageThumbnail string Xslt2 string
MetaInherited integer RenderWebsiteMap() string
Dim userObj As Ektron.Cms.UserData
userObj = userAPI.GetUserByUsername("admin") LoginAttempts Int16 Subscription Class 2 - DefaultMessage
3 - Verification
Id integer Xslt3 string webSitemap WebsiteMap GetUserCustomProperties() DateCreated string 4 - RequestResetPassword
Xslt4 string HasChildren boolean LastLoginDate string Ektron.Cms.API.Subscription DefaultMessage integer
Permissions PermissionData PublishPdfEnabled boolean
childrenNodes WebsiteMap() CustomAttribute()
LanguageId integer Xslt5 string
PublishPdfActive boolean
displayType string See User Data Classes > CustomAttribute Path string Methods Is this the default message?

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.

startLevel integer = 0 (optional) GetAllSubscriptions() SubscriptionData()


IsDomainFolder boolean See User Data Classes > UserGroupData User’s display alias used in forums, etc.
See Subscription Data Classes > SubscriptionData
Set to 0 for start from root. name string Signature string Returns an array of SubscriptionData classes
representing all subscriptions, both active and inactive.

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.

GetUserPermissions() AcceptedTerms boolean GetSubscription() SubscriptionData


Content Class LastEditDate string XmlAdvConfig string DomainStaging string User Class Id integer Id integer See Subscription Data Classes > SubscriptionData
DisplayLastEditDate string DateCreated string DomainProduction string
Ektron.Cms.API.Content.Content DateCreated DateTime DisplayDateCreated string FolderType integer Ektron.Cms.API.User.User ItemType string Username string
For a given ID, returns a SubscriptionData class
populated with settings for that Subscription

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?

dontCreateTask string MetaDisplay boolean UpDateUserGroup() (overloaded) TagType integer Ektron.Cms.EmailFromData


Name string getSameLevelNodes boolean = false GetAllUsers() UserGroupData() (overloaded)
UserID integer Language integer data UserData IsList boolean Class representing the emails from which a subscription is
Description string (optional) See User Data Classes > UseGroupData
See User Data Classes > UserData sent.
TaskTitle string SelectableText string Inherited boolean True = include all sites at same level as folderId userRequest UserRequestData IsDisplayedInEktronExplorer boolean Id integer
Sample Code: See User Data Classes > UseRequestData UserObject() UserData (overloaded)
SaveContent() boolean AllowMulti boolean InheritedFrom integer Dim sitemapApi As New Ektron.Cms.API.SiteMap See User Data Classes > UserData DoesAtrributeExist boolean Email string
GetGroupsUserIsIn() GroupData()
contentEditData ContentEditData IsSelectableOnly boolean PrivateContent boolean Dim mapData As Ektron.Cms.Common.WebsiteMap Id integer Ektron.Cms.GroupData Ektron.Cms.EmailMessageData
mapData = sitemapApi.GetWebsiteMap(14, False) UserId integer
See Content Data Classes > ContentEditData MetaDisplayEE boolean XmlInherited boolean UserObject() UserData (overloaded) Class representing Subscription Email messages.
UndoCheckout() boolean RenderFolderBreadcrumbHtml() string OrderBy string See User Data Classes > UserData GroupPath string
IsMetadataBlog boolean XmlInheritedFrom integer GroupID DisplayGroupName string Id integer
ContentId integer nodes() Ektron.Cms.Common.SitemapPath sUserName string
BlogMetaType integer XmlConfiguration XmlConfigData() Title String
GroupName
GroupId integer Title string
UpdateContentMetaData() boolean Ektron.Cms.XmlConfigData See Content Data Classes > XmlConfigData Url String GetMembershipUser() UserData Ektron.Cms.API.User.User GroupName string
Title of the Subscription message.
ContentID integer StyleSheet string Description String See User Data Classes > UserData Text string
MetaID integer
Id integer
TemplateFileName string
Order Integer Username string Properties GroupDomain string Text of the message.
Title string FolderId Integer
GetUserByUserName() UserData UserIdAuthenticated integer AdGroupName string LanguageId integer
MetaText string Description string StyleSheetInherited boolean Language Integer
Note: Ad stands for Active Directory Language ID code of the message.
User Data Classes
See User Data Classes > UserData
TemplateInherited boolean pathSeparator string
Content Data Classes EditXslt string
ApprovalMethod integer linkNodes boolean
Gets the user by their user name.
Username string
AdGroupDomain string Type Common.EkEnumeration.EmailMessageTypes
What type of message is it?
Ektron.Cms.ContentData SaveXslt string
ChildFolders FolderData() linkTarget string Sample Code: Ektron.Cms.UserData Note: Ad stands for Active Directory
IsMemberShipGroup boolean 0 - OptOut
Image string Xslt1 string displayVertical boolean Dim userAPI As New Ektron.Cms.API.User.User Inherits CMSObject 1 - Unsubscribe
MetaInheritedFrom integer
ImageThumbnail string Xslt2 string
MetaInherited integer RenderWebsiteMap() string
Dim userObj As Ektron.Cms.UserData
userObj = userAPI.GetUserByUsername("admin") LoginAttempts Int16 Subscription Class 2 - DefaultMessage
3 - Verification
Id integer Xslt3 string webSitemap WebsiteMap GetUserCustomProperties() DateCreated string 4 - RequestResetPassword
Xslt4 string HasChildren boolean LastLoginDate string Ektron.Cms.API.Subscription DefaultMessage integer
Permissions PermissionData PublishPdfEnabled boolean
childrenNodes WebsiteMap() CustomAttribute()
LanguageId integer Xslt5 string
PublishPdfActive boolean
displayType string See User Data Classes > CustomAttribute Path string Methods Is this the default message?

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.

startLevel integer = 0 (optional) GetAllSubscriptions() SubscriptionData()


IsDomainFolder boolean See User Data Classes > UserGroupData User’s display alias used in forums, etc.
See Subscription Data Classes > SubscriptionData
Set to 0 for start from root. name string Signature string Returns an array of SubscriptionData classes
representing all subscriptions, both active and inactive.

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

Quicklink string EventLongDescription() string


SearchManager Class
Sample Code:
GetBlogData() BlogData (overloaded) CategoryID integer
Search based on taxonomy category. In this example we search
for the category of Manchester. Title string Calendar() CalendarData
Asset Class See Blog Data Classes > BlogData The ID of the Category metadata definition. Taxonomy Data Classes
Ektron.Cms.API.Search.SearchManager Dim resultCount As Integer
Dim result() As SearchResponseData = _
Address string See Calendar Data Classes > CalendarData Ektron.Cms.API.Content.Asset folder_data FolderData Message string Ektron.Cms.TaxonomyData
Methods search.Search(requestData, HttpContext.Current, _ Description string Ektron.Cms.CalendarData Methods
See Folder Data Classes > FolderData
If you have a folder data class with a folder type blog and
Mask for base.html; the contents of the post.
Comments BlogComment()
Inherits TaxonomyBaseData
resultCount)
MapCategories string AvailableLanguages LanguageData() need to get the blog information, pass the folder data to this
See Blog Data Classes > BlogComment
TaxonomyItems TaxonomyItemData()
Execute ContentData() (overloaded) Dim search As SearchManager = New SearchManager() GetViewUrl() string method and get the populated blogdata back. See Taxonomy Data Classes > TaxonomyItemData
Dim requestData As SearchRequestData = New _ MapTime DateTime CalendarID integer GetBlogData() BlogData (overloaded)
Array of blog comments.
Use this method with the deprecated version of Search.
SearchRequestData()
Returns the URL for an asset.
PostID integer Taxonomy TaxonomyData()
It does not work with WebSearch.
condition Ektron.Cms.ContentSearchCondition
requestData.SearchFor = _ Calendar Class CalendarTitle string AssetId string (required)
ContentType integer
See Blog Data Classes > BlogData
BlogID integer
The ID of the post. TaxonomyXml string
Ektron.Cms.WebSearch.SearchDocumentType.all CalendarDescription string
Sample Code: requestData.GroupBy = "taxCategory" Ektron.Cms.API.Calendar.Calendar Get a blog for a given ID, returns all posts. Ektron.Cms.BlogRoll Ektron.Cms.TaxonomyBaseData
Dim isEnglish As ContentSearchCondition = New _
ContentSearchCondition
requestData.SearchText = "Manchester"
Dim resultCount As Integer Methods
RootFolderID integer
RootFolderPath string
Asset Data Class GetBlogData() BlogData (overloaded) Items BlogRollItem TaxonomyId integer
TaxonomyName string
Ektron.Cms.Common.AssetData
isEnglish.setType = SearchType.EQUAL Dim result() As String = _ See Blog Data Classes > BlogData Array of blog roll links.
isEnglish.setValue = 1033 search.SearchForCategories(requestData, _ CreateLangArrayFromCSlist() Read only. Gets all posts for a given ID and a given date. See Blog Data Classes > BlogRollItem
ShowWeekend boolean TaxonomyLanguage integer
isEnglish.setVariable = Content.content_language HttpContext.Current, 0, 0, resultCount) LanguageData() Id String BlogID integer ID integer
Dim isTitleLikeTest As ContentSearchCondition = New _
SearchTable DataSet TableHeight integer TaxonomyLanguageName string
ContentSearchCondition inList string Version String StartDate DateTime ID of the Blog.
isTitleLikeTest.setType = SearchType.LIKE searchReqData SearchRequestData TableHeight is deprecated.
RollItem BlogRollItem TaxonomyDescription string
DeleteCalendar() boolean TableWidth() integer MimeType As String GetBlogData() BlogData (overloaded)
isTitleLikeTest.setValue = "test" See Search Data Classes > SearchRequestData See Blog Data Classes > BlogData Property to obtain a specific blogroll link. TaxonomyParentId integer
isTitleLikeTest.setVariable = Content.content_title
searchParams string id integer LocationLabel string MimeName String See Blog Data Classes > BlogRollItem
Dim condition As ContentSearchCondition = New _ Sample Code: BlogID integer TaxonomyLevel integer
ContentSearchCondition context HttpContext Dim calendarApi As New _ StartLabel string FileName String index integer TaxonomyPath string
StartDate DateTime
condition.setType = SearchType.AND
resultCount integer Ektron.Cms.API.Calendar.Calendar
EndLabel string FileExtension Date to get posts from. Length integer TaxonomyCreatedDate DateTime
condition.AddCondition(isTitleLikeTest) Dim deleted As Boolean = True
condition.AddCondition(isEnglish) # of records returned deleted = calendarApi.DeleteCalendar(4) ForwardOnly Boolean ImageUrl String Postvisible integer
Number of blog roll links.
TaxonomyItemCount integer
Dim search As New SearchManager
Dim result As ContentData() = search.Execute(condition) WebSearch Data Classes GetAllCalendars() CalendarData() Only display event this day and forward. Icon String # of posts to return.
0 (zero) = no limit
Ektron.Cms.BlogRollItem TaxonomyHasChildren boolean
See Calendar Data Classes > CalendarData EventTypeLabel string Status String LinkName string
Execute UserData() (overloaded) Ektron.Cms.WebSearch.SearchData.SearchRequestData -1 = all posts for the day are shown Ektron.Cms.TaxonomyItemData
Use this method with the deprecated version of Search. GetCalendar() CalendarData EventTypeAvailable string Language String -2 = all posts for the month are shown Name of link.
It does not work with WebSearch. SearchText string See Calendar Data Classes > CalendarData
EventTypeRequired boolean Type Integer -3 = uses the # of Post Visible from the Workarea URL string TaxonomyId integer
condition Ektron.Cms.UserSearchCondition Text for which to search. Defaults to blank. CalendarID integer ContentLanguage integer LanguageID integer URL of blog roll link. TaxonomyLanguage integer
MaxResults integer PluginType String
Sample Code: Sample Code: GetBlogDataForPost() BlogData ShortDescription string TaxonomyItemId integer
Dim isMemberShip As UserSearchCondition = New _ Maximum number of results returned if paging not enabled. Dim calendarApi As New _ LongDescriptionAvailable integer PublishPdfActive Boolean = False A quick description of the link.
Ektron.Cms.API.Calendar.Calendar Allowed to have long description for events in the
See Blog Data Classes > BlogData TaxonomyItemLanguage integer
Blog Class
UserSearchCondition Defaults to 250.
Dim cData As New Ektron.Cms.Common.CalendarData calendar.
Obtains blog information for a given post ID. Relationship string TaxonomyItemType integer
isMemberShip.setType = SearchType.EQUAL
isMemberShip.setValue = 1
FolderID integer cData = calendarApi.GetCalendar(4) 0 = not allowed post_id integer XFN relationship value.
isMemberShip.setVariable = Users.membership_user
FolderID from which search should start. Default folder is 0.
GetFolderWithChildren() FolderData 1 = Text only Ektron.Cms.API.Content.Blog GetBlogPostData() ID integer TaxonomyItemType integer
Dim isInEktron As UserSearchCondition = New _ Recursive boolean See Folder Data Classes > FolderData 2 = Rich Text (HTML) Returns post information for a given post ID. Returns ID of blog roll entry. TaxonomyItemAddedUser integer
UserSearchCondition Is search recursive or limited to specified folder? Default is LongDescriptionAvailableText string Methods
inFolderID integer
Taxonomy Class TaxonomyItemTitle string
tags, trackback, pingback, and categories for post.
isInEktron.setType = SearchType.EQUAL recursive.
isInEktron.setValue = "03031" SaveCalendar() integer
String value of LongDescriptionAvailable property.
AddBlog() integer id integer TaxonomyItemTeaser string
OrderBy string EventTypeInstructions string
isInEktron.setVariable = "zip"
Order search results by specified column. Defaults to Rank. inCalendar CalendarData Gets text displayed next to event type selector.
ParentFolderID integer GetBlogRoll() integer (overloaded) Ektron.Cms.API.Content.Taxonomy TaxonomyItemQuickLink string
Dim condition As UserSearchCondition = New _ Returns blog roll for a given blog ID.
UserSearchCondition OrderDirection string See Calendar Data Classes > CalendarData
ShowAllEventTypes string
Folder ID where blog will be created. Methods TaxonomyItemAssetInfo
condition.setType = SearchType.AND Order by ascending or descending. Defaults to Descending. Sample Code: BlogName string blog_id integer
Dim calendarApi As New _ Gets text displayed to “show all” events in the AddTaxonomyItem() (overloaded) Ektron.Cms.Common.AssetData
condition.AddCondition(isInEktron)
CurrentPage Ektron.Cms.API.Calendar.Calendar event type selector. Name of blog. GetBlogRoll() string (overloaded)
condition.AddCondition(isMemberShip)
BlogTitle string Returns blog roll for a given blog path.
Use to assign one content block to several TaxonomyItemEditorLastName string
Dim cData As New Ektron.Cms.CalendarData
Analytics Class
Dim search As New SearchManager Used for paging through results. categories.
Dim result As UserData() = search.Execute(condition) SearchReturnType Dim id As Integer = 0 Title of blog. Path string request TaxonomyContentRequest TaxonomyItemEditorFirstName string
cData.CalendarID = 0 ‘leave 0 to add new BlogDescription string TaxonomyItemDisplayDateModified
Search MapResponseData() (overloaded) Defaults to HTML (html, datatable or xml).
cData.CalendarTitle = “Example Calendar” Ektron.Cms.API.Analytics.Analytics GetPost() ContentData See Taxonomy Data Classes >
mapReqData MapRequestData LanguageID integer cData.CalendarDescription = “Example Calendar” Visibility Ektron.Cms.Common.EkEnumeration.BlogVisibility See Content Data Classes > ContentData TaxonomyContentRequest string
Language of contents to be searched. Defaults to 1033 cData.RootFolderID = 0 Methods Is blog visible to public or restricted? Returns ContentData class for a given post ID and a AddTaxonomyItem() (overloaded) Ektron.Cms.TaxonomyFolderSyncData
context HttpContext (English). cData.ShowWeekend = True Public BlogPostData class. Use when several content blocks are
GetSessionRank() integer
index integer PageSize cData.EventTypeAvailable = True
0 = first page a new user has visited
Private post_id integer assigned one particular category. TaxonomyId integer
cData.EventTypeRequired = False EnableComments boolean request TaxonomyRequest
page number Defaults to providerPageSize.
id = calendarApi.SaveCalendar(cData) 1 = first page a returning user has visited PostInfo BlogPostData TaxonomyLanguage integer
count integer Weights 2 = any other page Is commenting enabled?
GetPostbyID() BlogPostData
See Taxonomy Data Classes >
FolderId integer
page size Used for weighted word search. This is specific to the CalendarEvent Class page System.Web.UI.Page ModerateComments boolean See Blog Data Classes > BlogPostData
TaxonomyRequest
AddTaxonomySyncFolder() FolderTitle string
resultCount integer IndexService Sample Code: Are comments moderated? Returns a BlogPostData class for a given post ID.
SearchType string Ektron.Cms.API.Calendar.CalendarEvent Dim AnalyticsAPI As New _ RequireAuthentication boolean Once data is created using this method, it Ektron.Cms.TaxonomyItemRequest
# of records returned
Ektron.Cms.API.Analytics.Analytics post_id integer
Sample Code: Type of search to perform. Defaults to “and” Methods Do comments require authentication?
watches the folder for auto entries to this category
Inherits TaxonomyItemBaseRequest
The example demonstrates how to retrieve geo-content from
CMS400.Net.
none
and DeleteEvent()
Dim session_rank As Integer = _
AnalyticsAPI.GetSessionRank(Me.Page) Categories string Blog Data Classes when adding or editing the content block.
request TaxonomySyncRequest TaxonomyItemList integer
Response.Write(session_rank) Array of categories for blog. TaxonomyItemLanguage integer
Dim search As SearchManager = New SearchManager()
Dim requestData As MapRequestData = New MapRequestData()
or
andnot
eventID integer HardDumpAnalyticsBuffer() RollLinks BlogRoll Ektron.Cms.BlogComment See Taxonomy Data Classes >
TaxonomySyncRequest TaxonomyItemType integer
Dim index As Integer = 1 near LoadEvent() CalendarEventData Forces analytics buffer to write to database. A list of links for the blog. Title string CreateTaxonomy() integer
Dim pageSize As Integer = 10 weighted eventID integer Surpasses checks to see if time before AddCommentForPost() boolean Ektron.Cms.TaxonomyContentRequest
requestData.LanguageID = 1033
SearchFor string write or number of records before write has passed. DisplayName string request TaxonomyData
Dim meta As MetaData = New MetaData() Sample Code: Adds a blog post comment. Display name of the user who posted comment (if applicable). ContentId integer
Type of content to search. By default, all are searched. Dim calendarApi As New _ QueryAnalytics() DataSet bcComment BlogComment
See Taxonomy Data Classes > TaxonomyData
meta.MetaDataValue = -71.495246887207
all Ektron.Cms.API.Calendar.CalendarEvent Email string DeleteTaxonomy() TaxonomyList string
meta.MetaDataValue2 = 71.6737747192383
Dim cData As New Ektron.Cms.CalendarEventData selectCommands() string See Blog Data Classes > BlogComment
meta.Operator = MetaOperator.and html Email address of user who posted comment.
request TaxonomyRequest Ektron.Cms.TaxonomyRequest
meta.DataComparer = MetaComparer.range documents cData = calendarAPI.LoadEvent(1) array of SQL queries in string format AddPost() integer URI string Inherits TaxonomyBaseRequest
meta.MetaName = "MapLongitude" images SaveEvent() Integer SoftDumpAnalyticsBuffer() boolean blogID integer Website of user who posted comment.
See Taxonomy Data Classes >
Dim meta2 As MetaData = New MetaData() multimedia Writes analytics buffer to database only if
TaxonomyRequest SearchText string
CalEvent ID of blog to which post is added. Message string GetTaxonomyIdByPath() integer TaxonomyIdList string
meta2.MetaDataValue = 42.7437345034087 UserId integer TimeBeforeWrite or HitsBeforeWrite conditions
PostContent ContentData
meta2.MetaDataValue2 = 42.8747061062372 User ID on which to filter private documents. Ektron.Cms.CalendarEventData are surpassed. The text of the comment. Returns the taxonomy by its path.
FolderId integer
meta2.Operator = MetaOperator.and
EnablePaging boolean See Calendar Data Classes > CalendarEventData TrackVisit() (overloaded) A content data class representing the post. ID integer Note: This is not a CMS400.NET folder path, it
meta2.DataComparer = MetaComparer.range
associatedIDs String = "" (optional) Same as TrackVisit(Page), but does not
See Content Data Classes > ContentData ID of comment. is the taxonomy path. For example: TaxonomyItemType integer
meta2.MetaName = "MapLatitude" Do you want to get paged results?
By default, paging is enabled and page size set to 10. Only for reoccuring events. Updates all automatically pull information from a Page object, Categories string DateCreated DateTime
\MapCategory\Restaurant\American
IncludeItems boolean
requestData.MetaDataNameList = New MetaData() {meta,
pass those values down yourself. An array of categories for post. path string
meta2} Modify provider settings in web.config to modify page size. reoccuring events with event data.
Pingback boolean PostID integer Depth integer
content_id integer Sample Code:
Category string
Calendar Data Classes
Dim resultCount As Integer ID of post for the comment.
Dim result() As MapResponseData = _ user_id integer Tags string
Dim TaxAPI As New _ Preview boolean
search.Search(requestData, HttpContext.Current, index, _
Taxanomy category for which to search. Defaults to blank.
ProviderName string Ektron.Cms.BlogData Ektron.Cms.API.Content.Taxonomy
Dim TaxID As Integer ReadCount boolean
Ektron.Cms.CalendarEventData
CMS user or Membership user ID. 0 = visitor String list of tags for this post.
pageSize, resultCount)
Search SearchResponseData() (overloaded) Index Service provider to use. Defaults to Dialect2 provider. visitor_id string TrackbackURL string Inherits FolderData TaxID = _
TaxAPI.GetTaxonomyIdByPath("\MapCategory")
Page System.Web.UI.Page
Can be changed in Web.config. EventID integer session_rank integer URL for which to trackback. BlogID integer Response.Write(TaxID) Ektron.Cms.TaxonomyItemBaseRequest
searchReqData SearchRequestData GroupBy string DeleteBlog() Content BlogPostData()
EventTitle string 0 = first page a new user has visited ImportTaxonomy() integer Inherits TaxonomyBaseRequest
context HttpContext Only Dialect provider supports this GroupBy column name. 1 = first page a returning user has visited Deletes blog and all associated comments and posts. See Blog Data Classes > BlogPostData
CalendarID integer TaxonomyXml string Ektron.Cms.TaxonomySyncRequest
resultCount integer Note: Ranking is altered if you do group by. 2 = any other page BlogID integer Posts of the blog.
# of records returned Ektron.Cms.WebSearch.SearchData.MapRequestData EventLocation string referring_url string ID of blog to be deleted. Visibility Ektron.Cms.Common.EkEnumeration.BlogVisibility Title string Inherits TaxonomyBaseRequest

EventDay integer LoadTaxonomy() TaxonomyData SyncIdList string


Sample Code: Inherits from SearchRequestData url string Sample Code:
Dim BlogAPI As New Ektron.Cms.API.Content.Blog
Public
The example demonstrates how to retrieve content that contains
CurrentLongitude integer EventMonth integer Private See Taxonomy Data Classes > TaxonomyData SyncRecursiveIdList string
“research” and has a searchable metadata “wellness” set to “Cancer”. TrackVisit() (overloaded) BlogAPI.DeleteBlog(202)
Title string
Dim search As SearchManager = New SearchManager() CurrentLatitude integer EventYear integer Tracks a visit and passes down viewed content DeletePost() boolean request TaxonomyRequest Ektron.Cms.TaxonomyBaseRequest
Dim requestData As SearchRequestData = New _
Ektron.Cms.WebSearch.SearchData.MapRequestData EventDescription string ID. It automatically pulls user_id, visitor_id,
Deletes post and all associated comments.
Tagline string See Taxonomy Data Classes > Inherits SortRequest
SearchRequestData() session_rank, referring_url and URL from the page TaxonomyRequest
EventStartTime Date post_id integer PostsVisible integer TaxonomyId integer
requestData.LanguageID = 1033 Characterization string object. ReadAllAssignedCategory()
requestData.SearchText = "research"
EventStartTimeDisplay string page System.Web.UI.Page ID of post to be deleted. Number of posts to appear on blog. Can be overridden TaxonomyLanguage integer
Dim meta As MetaData = New MetaData() DateCreated DateTime GetBlankBlogPostData() BlogPostData
on the server control. TaxonomyBaseData()
EventShowStartTime boolean content_id integer EnableComments boolean See Taxonomy Data Classes > Ektron.Cms.SortRequest
meta.MetaDataValue = "Cancer"
meta.DataComparer = MetaComparer.equalTo
DateModified DateTime See Blog Data Classes > BlogPostData TaxonomyBaseData Inherits PageRequestData
ContentID integer Display start time in the calendar output.
Ektron.Cms.API.Analytics.Analytics Get a populated blogpostdata class with the trackback, ping, ModerateComments boolean contentid integer
meta.MetaName = "wellness"
EventEndTime Date tags and categories definition IDs. A utility function for the Are comments moderated? SortOrder string
requestData.MetaDataNameList = New MetaData() {meta}
Dim resultCount As Integer
ContentLanguage integer
EventEndTimeDisplay String Properties CMS.
RequiresAuthentication boolean ReadTaxonomy() TaxonomyData SortDirection string
Dim result() As SearchResponseData = FolderID integer AnalyticsEnabled boolean GetBlog() BlogData (overloaded) Is authentication required to post comments? See Taxonomy Data Classes > TaxonomyData
Ektron.Cms.TaxonomyLanguageRequest
search.Search(requestData, HttpContext.Current, _ EventShowEndTime boolean request TaxonomyRequest
resultCount)
ContentType integer Display end time in the calendar output. Read only boolean value from web.config indicating Use a blog’s ID to get the blog.
NotifyURL string TaxonomyId integer
See Blog Data Classes > BlogData See Taxonomy Data Classes >
Search SearchResponseData() (overloaded) QuickLink string ContentID integer
whether or not analytics is enabled.
ID integer
URLs to notify when posts are added.
TaxonomyRequest IsTranslated boolean
Summary string AppendToIISLog boolean Categories string()
searchText string ContentLanguage integer Read only Boolean value from web.config Blog ID
Array of categories for the blog.
RemoveTaxonomyFolder() Ektron.Cms.MapCategoryData
context HttpContext LastAuthor string QLink string indicating whether or not content ID and user ID of StartDate string request TaxonomySyncRequest
BlogRoll BlogRoll CategoryId integer
resultCount integer Title string Quicklink of the associated content or a specified each visit is appended to the IIS logs. The date from which to get posts.
The blog’s roll. See Taxonomy Data Classes >
Size long hyperlink. InMemoryContentHitsData MaxEntries integer See Blog Data Classes > BlogRoll TaxonomySyncRequest CategoryTitle string
# of records returned
LaunchNewBrowser boolean ContentHitsData # of posts to return. RemoveTaxonomyItem() CategoryPath string
SearchForCategories string() Category string
AuthorLastName string A shared (static) strongly typed dataset containing 0 = no limit Ektron.Cms.BlogPostData request TaxonomyRequest ParentId integer
searchReqData SearchRequestData FileImage string all tracking information. This should not be -1 = all posts for the day are shown
TrackBackURL string
See Search Data Classes > SearchRequestData AuthorFirstName string manipulated directly. -2 = all posts for the month are shown See Taxonomy Data Classes > HasChildren boolean
Ektron.Cms.WebSearch.SearchData.MapResponseData -3 = use the # of Post Visible from the Workarea The URL(s) for which to trackback.
TaxonomyRequest
context HttpContext EventRecursionID integer RecordsBeforeWrite integer ReOrderTaxonomyItems() Category MapCategoryData()
Longitude double Read only. LanguageID integer Tags string
index integer Indicates number of records to hold in static
request TaxonomyRequest
page number Distance double 0 = event is not reoccurring. Otherwise, it returns memory buffer before writing to database. This GetBlog() BlogData (overloaded) Tags for the post.
shared ID for all recursions of the event. See Taxonomy Data Classes >
count integer Latitude double smoothes out the number of writes to database. Use a blog’s folder path to get the blog. Pingback boolean
EventRecursionType() TimeBeforeWrite integer See Blog Data Classes > BlogData The URL(s) to pingback when the post is published.
TaxonomyRequest
page size MetaInfo string CalendarEventAPI.RecursionType path string UpdateTaxonomy()
resultCount integer
Indicates number of seconds before writing in- Categories string()
Summary string Public Enum RecursionType memory buffer of records to database. This Folder path to the blog. request TaxonomyData
# of records returned smoothes out the number of writes to database. TrackBackURLID integer
See Sample for this method at top of next column.
Daily = 0 StartDate string The ID of the Trackback metadata definition.
See Taxonomy Data Classes > TaxonomyData
Weekly = 1 The date from which to get posts.
MonthlyByDay = 2 TagsID integer
MonthlyByWeekday = 3 MaxEntries integer The ID of the Tags metadata definition.
YearlyByMonthDay = 4 See above MaxEntries description from first GetBlogData().
PingBackID integer
YearlyByMonthWeekDay = 5 LanguageID integer The ID of the Pingback metadata definition.

S-ar putea să vă placă și