ROIWebInterface Methods
The ROIWebInterface type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
![]() | AddUserToUserGroup |
Method to add a user to a user group
|
![]() | CreateUser |
Tries to create a new user withe matching username and password.
|
![]() | Dispose | Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources. (Inherited from MarshalByValueComponent.) |
![]() | DoesUserExist |
Checks whether the username already exists on the deployment.
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | (Inherited from MarshalByValueComponent.) |
![]() | GetAllUserGroups |
Method to return array of custom UserGroup objects based on all user groups retrieved from Storefront
|
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLoginTicket |
Gets a single-use Storefront login ticket valid for 24 hours.
|
![]() | GetOrder |
This method retrieves information about a Storefront order identified by the specified ID and sends the result back through a web interface
|
![]() | GetOrderIdListByDateRange |
This method retrieves all order IDs for orders placed between the specified date range. Note that the list is not guaranteed to be sorted in any particular order
|
![]() | GetOrderIdListForDate |
This is a convenient method to get all order Ids specified by the date portion of the input parameter. This input date get translated to a date range between 0h 0m 0h and 23h 59m 59s for the specified date
|
![]() | GetOrderItem |
This method retrieves information about a Storefront order item identified by the specified id and sends the result back through a web interface
|
![]() | GetOrderItemList |
This is a convenient method to retrieve an array of Document objects specified by the array of document IDs
|
![]() | GetOrderListByDateRange |
This method retrieve all orders placed between the specified date and time range ad return an array of Order objects representing these orders. The array is not guaranteed to be sorted in any particular order
|
![]() | GetOrderListForDate |
This is a convenient method to get all orders specified by the date portion of the input date parameter. This input date traslates to a date range between 0h 0m 0s and 23h 59m 59s for the specified date
|
![]() | GetProduct |
This web method retrieves information about a Storefront product identified by the specified ID
|
![]() | GetProductIdListOfActiveProducts |
Method to retrieve Product IDs of all live Stroefront products
|
![]() | GetProductList |
This is a convenient method to retrieve an array of Product objects specified by the array of product IDs
|
![]() | GetService | Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUserById |
This web method retrieves information about a Storefront user identified by the specified ID
|
![]() | GetUserByLogonName |
This web method retrieves information about a Storefront user identified by the specified LogonName
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RegisterCallback |
This web method allows registration of a client callback web pages allowing Pageflex Storefront to alert the client to events.
The Storefront API will send a request string using the GET protocol name = event id and value = item id.
Similar to all callback URLs, the URL must implement a test callback where if both ids equal "test" it replies with raw ascii "test".
The full URL must be based on the domain name given in the extension settings e.g. www.thirdparty.com.
|
![]() | RemoveUserFromUserGroup |
Method to remove a user from a user group
|
![]() | SetOrderItemStatus |
Sets the order item status where status changes outside the scope of the Storefront system.
|
![]() | SetUserFields |
This method sets values of relevant user fields of a user object
|
![]() | ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.) |
![]() | UnregisterCallback |
This web method cancels the registration of a client callback made using the RegisterCallback we method.
The full URL must be based on the domain name given in the extension settings e.g. www.thirdparty.com
|
See Also

