Documentation Summary

ROI Storefront API

ROIWebInterface Methods

The ROIWebInterface type exposes the following members.

Methods

  NameDescription
Public methodAddUserToUserGroup
Method to add a user to a user group
Public methodCreateUser
Tries to create a new user withe matching username and password.
Public methodDispose 
Releases all resources used by the MarshalByValueComponent.
(Inherited from MarshalByValueComponent.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the MarshalByValueComponent and optionally releases the managed resources.
(Inherited from MarshalByValueComponent.)
Public methodDoesUserExist
Checks whether the username already exists on the deployment.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Inherited from MarshalByValueComponent.)
Public methodGetAllUserGroups
Method to return array of custom UserGroup objects based on all user groups retrieved from Storefront
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLoginTicket
Gets a single-use Storefront login ticket valid for 24 hours.
Public methodGetOrder
This method retrieves information about a Storefront order identified by the specified ID and sends the result back through a web interface
Public methodGetOrderIdListByDateRange
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
Public methodGetOrderIdListForDate
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
Public methodGetOrderItem
This method retrieves information about a Storefront order item identified by the specified id and sends the result back through a web interface
Public methodGetOrderItemList
This is a convenient method to retrieve an array of Document objects specified by the array of document IDs
Public methodGetOrderListByDateRange
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
Public methodGetOrderListForDate
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
Public methodGetProduct
This web method retrieves information about a Storefront product identified by the specified ID
Public methodGetProductIdListOfActiveProducts
Method to retrieve Product IDs of all live Stroefront products
Public methodGetProductList
This is a convenient method to retrieve an array of Product objects specified by the array of product IDs
Public methodGetService
Gets the implementer of the IServiceProvider.
(Inherited from MarshalByValueComponent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserById
This web method retrieves information about a Storefront user identified by the specified ID
Public methodGetUserByLogonName
This web method retrieves information about a Storefront user identified by the specified LogonName
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRegisterCallback
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.
Public methodRemoveUserFromUserGroup
Method to remove a user from a user group
Public methodSetOrderItemStatus
Sets the order item status where status changes outside the scope of the Storefront system.
Public methodSetUserFields
This method sets values of relevant user fields of a user object
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from MarshalByValueComponent.)
Public methodUnregisterCallback
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
Top
See Also