| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
currentSession* | ConverterUserSession |
This property contains information about the client's current session.
If the client is not logged on, the value is null.
|
defaultLocale P | xsd:string |
This is the default server locale.
|
messageLocaleList* P | xsd:string[] |
Provides the list of locales for which the server has localized messages.
|
sessionList* P | ConverterUserSession[] |
The list of currently active sessions.
|
supportedLocaleList* P | xsd:string[] |
Provides the list of locales that the server supports.
Listing a locale ensures that some standardized information such as dates appear
in the appropriate format. Other localized information, such as error messages,
are displayed, if available. If localized information is not available, the
message is returned using the system locale.
|
Methods
Methods defined in this Managed Object |
---|
ConverterImpersonate, ConverterLogin, ConverterLoginExtension, ConverterLoginSession, ConverterLogout, ConverterSetLocale, ConverterTerminateSession |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
locale* P | xsd:string |
A two-character ISO-639 language ID (like "en")
optionally followed by an
underscore and a two-character ISO 3166 country ID (like "US").
Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported. Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterUserSession | The UserSession object. |
Faults
Type | Description |
---|---|
InvalidLocale | Thrown if the locale is invalid or unknown to the server. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
userName P | xsd:string |
The name of the user who is logging on to the server.
Since Converter API 1.0 |
password P | xsd:string |
The password of the user who is logging on to the server.
Since Converter API 1.0 |
locale* P | xsd:string |
A two-character ISO-639 language ID (like "en")
optionally followed by an
underscore and a two-character ISO 3166 country ID (like "US").
Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported. Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterUserSession | The UserSession object. |
Faults
Type | Description |
---|---|
InvalidLocale | Thrown if the locale is invalid or unknown to the server. |
InvalidLogin | Thrown if the user and password combination is invalid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
userName P | xsd:string |
The name of the VC user who is logging on to the server.
Since Converter API 1.0 |
password P | xsd:string |
The password of the user on VC.
Since Converter API 1.0 |
locale* P | xsd:string |
A two-character ISO-639 language ID (like "en")
optionally followed by an
underscore and a two-character ISO 3166 country ID (like "US").
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterUserSession | The UserSession object. |
Faults
Type | Description |
---|---|
InvalidLocale | Thrown if the locale is invalid or unknown to the server. |
InvalidLogin | Thrown if the user and sessionId combination is invalid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
userName P | xsd:string |
The name of the VC user who is logging on to the server.
Since Converter API 1.0 |
sessionId P | xsd:string |
The session ID of the user's active VC session.
Since Converter API 1.0 |
locale* P | xsd:string |
A two-character ISO-639 language ID (like "en")
optionally followed by an
underscore and a two-character ISO 3166 country ID (like "US").
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
ConverterUserSession | The UserSession object. |
Faults
Type | Description |
---|---|
InvalidLocale | Thrown if the locale is invalid or unknown to the server. |
InvalidLogin | Thrown if the user and sessionId combination is invalid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
locale P | xsd:string |
A two-character ISO-639 language ID (like "en")
optionally followed by an
underscore and a two-character ISO 3166 country ID (like "US").
Examples are "de", "fr_CA", "zh", "zh_CN", and "zh_TW". Note: The method uses the server default locale when a locale is not provided. This default can be configured in the server configuration file. If unspecified, it defaults to the locale of the server environment or English ("en") if unsupported. Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidLocale | Thrown if the locale is invalid or unknown to the server. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
This method is only transactional for each session ID. The set of sessions are terminated sequentially, as specified in the list. If a failure occurs, for example, because of an unknown sessionID, the method aborts with an exception. When the method aborts, any sessions that have not yet been terminated are left in their unterminated state.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ConverterSessionManager used to make the method call. |
sessionId P | xsd:string[] |
A list of sessions to terminate.
Since Converter API 1.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
NotFound | Thrown if a sessionId could not be found as a valid logged-on session. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |