erminas.SmartAPI.CMS.Project.Keywords.IKeyword Interface Reference

Inheritance diagram for erminas.SmartAPI.CMS.Project.Keywords.IKeyword:

Collaboration diagram for erminas.SmartAPI.CMS.Project.Keywords.IKeyword:

Public Member Functions
void	Commit ()
void	Delete ()
	Delete the keyword. The operation will fail, if it is still actively used in connecting pages to containers/lists.
void	DeleteForcibly ()
	Delete the keyword, even if it is actively used in connecting pages to containers/lists. This requires the session to contain your login password (it does, if you created the session object with valid ServerLogin.AuthData).
void	Rename (string newKeywordName)
Public Member Functions inherited from erminas.SmartAPI.CMS.IPartialRedDotObject
void	EnsureInitialization ()
void	Refresh ()

Properties
ICategory	Category [get]
Properties inherited from erminas.SmartAPI.CMS.Project.IProjectObject
IProject	Project [get]
Properties inherited from erminas.SmartAPI.CMS.ISessionObject
ISession	Session [get]

Detailed Description

Definition at line 24 of file IKeyword.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.Keywords.IKeyword.Commit

(

)

void erminas.SmartAPI.CMS.Project.Keywords.IKeyword.Delete

(

)

Delete the keyword. The operation will fail, if it is still actively used in connecting pages to containers/lists.

Exceptions

SmartAPIException

Thrown, if the keyword couldn't be deleted

Here is the caller graph for this function:

void erminas.SmartAPI.CMS.Project.Keywords.IKeyword.DeleteForcibly

(

)

Delete the keyword, even if it is actively used in connecting pages to containers/lists. This requires the session to contain your login password (it does, if you created the session object with valid ServerLogin.AuthData).

Exceptions

SmartAPIException

Thrown, if the keyword could not be deleted

Here is the caller graph for this function:

void erminas.SmartAPI.CMS.Project.Keywords.IKeyword.Rename

(

string

newKeywordName

)

Property Documentation

ICategory erminas.SmartAPI.CMS.Project.Keywords.IKeyword.Category

get

Definition at line 26 of file IKeyword.cs.

---

The documentation for this interface was generated from the following file:

• IKeyword.cs