Свойство | Type | Description | |
---|---|---|---|
CheckAlreadyLoggedIn | string | ||
CheckLoginResponse | void | ||
ExtractMessagesWithInnerExceptions | string | ||
GetDialogLocales | List |
||
GetForceLoginXmlNode | |||
GetLocales | List |
||
GetLoginResponse | |||
GetServerVersion | System.Version | ||
GetUserSessionInfoElement | |||
InitConnection | void | ||
IsProjectUnavailbaleException | bool | ||
LoadSelectedProject | void | ||
Login | void | ||
LoginToServerManager | void | ||
Logout | void | ||
ParseLoginResponse | void | ||
ParseRQLResult | |||
SendEmail | void | ||
SendRQLToServer | string | ||
Session | System | ||
TryGetSessionInfo | bool |
Méthode | Description | |
---|---|---|
Dispose ( ) : void |
Close session on the server and disconnect
|
|
ExecuteRQL ( string query ) : |
||
ExecuteRQL ( string query, |
||
ExecuteRQLInProjectContext ( string query, System.Guid projectGuid ) : |
||
ExecuteRQLInProjectContextAndEmbeddedInProjectElement ( string query, System.Guid projectGuid ) : |
||
ExecuteRQLRaw ( string query, |
||
GetTextContent ( System.Guid projectGuid, ILanguageVariant lang, System.Guid elementGuid, string typeString ) : string |
Get the text content of a text element. This method exists, because it needs a different RQL element layout than all other queries.
|
|
SelectProject ( System.Guid projectGuid ) : void |
Select a project. Subsequent queries will be executed in the context of this project.
|
|
SelectProject ( IProject project ) : void |
Select a project as active project (RQL queries will be evaluated in the context of this project).
|
|
SendMailFromCurrentUserAccount ( |
||
SendMailFromSystemAccount ( |
||
Session ( |
||
Session ( |
Create an session object for an already existing session on the server, e.g. when opening a plugin from within a running session.
|
|
SetTextContent ( System.Guid projectGuid, ILanguageVariant languageVariant, System.Guid textElementGuid, string typeString, string content ) : System.Guid |
Set the text content of a text element. This method exists, because it needs a different RQL element layout than all other queries.
|
|
WaitForAsyncProcess ( System.TimeSpan maxWait, Predicate |
Waits for an asynchronous process to finish. This is done by waiting for the process to spawn (or have it available on start) and then waiting for the process to disappear from the process list. The async processes get checked every second, for other retry periods, use
|
|
WaitForAsyncProcess ( System.TimeSpan maxWait, System.TimeSpan retry, Predicate |
Waits for an asynchronous process to finish. This is done by waiting for the process to spawn (or have it available on start) and then waiting for the process to disappear from the process list.
|
Méthode | Description | |
---|---|---|
CheckAlreadyLoggedIn ( |
||
CheckLoginResponse ( |
||
ExtractMessagesWithInnerExceptions ( |
||
GetDialogLocales ( ) : List |
||
GetForceLoginXmlNode ( |
||
GetLocales ( ) : List |
||
GetLoginResponse ( ) : |
||
GetServerVersion ( string baseURL ) : System.Version | ||
GetUserSessionInfoElement ( ) : |
||
InitConnection ( ) : void | ||
IsProjectUnavailbaleException ( |
||
LoadSelectedProject ( |
||
Login ( Func |
||
LoginToServerManager ( ) : void | ||
Logout ( System.Guid logonGuid ) : void | ||
ParseLoginResponse ( |
||
ParseRQLResult ( ISession session, string result ) : |
||
SendEmail ( string fromAddress, |
||
SendRQLToServer ( string rqlQuery, string debugRQLQuery = null ) : string |
Send RQL statement to CMS server and return result.
|
|
Session ( ) : System | ||
TryGetSessionInfo ( |
public ExecuteRQL ( string query ) : |
||
query | string | |
Résultat |
public ExecuteRQL ( string query, |
||
query | string | |
format | ||
Résultat |
public ExecuteRQLInProjectContext ( string query, System.Guid projectGuid ) : |
||
query | string | |
projectGuid | System.Guid | |
Résultat |
public ExecuteRQLInProjectContextAndEmbeddedInProjectElement ( string query, System.Guid projectGuid ) : |
||
query | string | |
projectGuid | System.Guid | |
Résultat |
public ExecuteRQLRaw ( string query, |
||
query | string | |
ioDataFormat | ||
Résultat | string |
public GetTextContent ( System.Guid projectGuid, ILanguageVariant lang, System.Guid elementGuid, string typeString ) : string | ||
projectGuid | System.Guid | Guid of the project containing the element |
lang | ILanguageVariant | Language variant to get the text from |
elementGuid | System.Guid | Guid of the text element |
typeString | string | texttype value |
Résultat | string |
public SelectProject ( System.Guid projectGuid ) : void | ||
projectGuid | System.Guid | Guid of the project to select |
Résultat | void |
public SelectProject ( IProject project ) : void | ||
project | IProject | Project to select |
Résultat | void |
public SendMailFromCurrentUserAccount ( |
||
Résultat | void |
public SendMailFromSystemAccount ( |
||
Résultat | void |
public Session ( |
||
login | ||
sessionReplacementSelector | Func |
|
Résultat | System |
public Session ( |
||
login | ||
loginGuid | System.Guid | |
sessionKey | string | |
projectGuid | System.Guid | |
Résultat | System |
public SetTextContent ( System.Guid projectGuid, ILanguageVariant languageVariant, System.Guid textElementGuid, string typeString, string content ) : System.Guid | ||
projectGuid | System.Guid | Guid of the project containing the element |
languageVariant | ILanguageVariant | Language variant for setting the text in |
textElementGuid | System.Guid | Guid of the text element |
typeString | string | texttype value |
content | string | new value |
Résultat | System.Guid |
public WaitForAsyncProcess ( System.TimeSpan maxWait, Predicate |
||
maxWait | System.TimeSpan | Maximum time span to wait for the process to complete |
processPredicate | Predicate |
Gets checked for every process in the list to determine the process to wait for (must return true for it and only for it) |
Résultat | void |
public WaitForAsyncProcess ( System.TimeSpan maxWait, System.TimeSpan retry, Predicate |
||
maxWait | System.TimeSpan | Maximum time span to wait for the process to complete |
retry | System.TimeSpan | Determines how often the async processes should be checked |
processPredicate | Predicate |
Gets checked for every process in the list to determine the process to wait for (must return true for it and only for it) |
Résultat | void |