Library Class

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

~/Workarea/webservices/WebServiceAPI/Library.asmx

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

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

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

C:\Inetpub\wwwroot\CMS400Developer\Developer\dotNetAssemblies\WebServicesAPI\LibraryAPI

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

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

Class Hierarchy

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.None)]
public class Library : EktronBaseService;

Visual Basic

<WebService(Namespace = "http://tempuri.org/")>
<WebServiceBinding(ConformsTo = WsiProfiles.None)>
Public Class Library
Inherits EktronBaseService

Library.cs

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

Library Methods

	Name	Description
	AddLoadBalanceItem	Adds a load balance path for files and images. This method can be accessed through the Library.asmx file located in:
	DeleteLibraryItem	Deletes the library item by extension. This method can be accessed through the Library.asmx file located in:
	DeleteLibraryItemById	Deletes the library items from the system. This method can be accessed through the Library.asmx file located in:
	DeleteLoadBalanceItem	Deletes the load balance item from the system. This method can be accessed through the Library.asmx file located in:
	GetAllChildLibItems	Loads all of the library items by type. This method can be accessed through the Library.asmx file located in:
	GetAllLoadBalancePaths	This is the overview for the GetAllLoadBalancePaths method overload.
	GetLibraryItem	This is the overview for the GetLibraryItem method overload.
	GetLibrarySettings	Loads the library settings. This method can be accessed through the Library.asmx file located in:
	GetLibraryTypes	Loads the library types. This method can be accessed through the Library.asmx file located in:
	GetLoadBalancePath	Gets the load balance path by ID. This method can be accessed through the Library.asmx file located in:
	InternalLibrarySearch	Searches library items. This method can be accessed through the Library.asmx file located in:
	UpdateLibrary	Updates a library item. This method can be accessed through the Library.asmx file located in:
	UpdateLibrarySettings	Update the library settings. This method can be accessed through the Library.asmx file located in:
	UpdateLoadBalanceSettings	Updates the load balance settings. This method can be accessed through the Library.asmx file located in:
	UpdateQlinkTemplates	Updates the Quicklink template. This method can be accessed through the Library.asmx file located in:

Links

Library Methods, Classes, Legend, Members, Topics, Library Methods

Created with a commercial version of

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

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!