ServiceResponse<TData> Class

Generic service response

Inheritance Hierarchy

System.Object
  CMS.WebServices.ServiceResponse
    CMS.WebServices.ServiceResponse<TData>

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 8.2.23

Syntax

public class ServiceResponse<TData> : ServiceResponse

Type Parameters

TData

Type of payload

The ServiceResponse<TData> type exposes the following members.

Constructors

	Name	Description
Public method	ServiceResponse<TData>()	Default constructor
Public method	ServiceResponse<TData>(TData)	Parametric constructor for OK cases
Public method	ServiceResponse<TData>(ResponseStatusEnum)	Parametric constructor for status response only
Public method	ServiceResponse<TData>(ServiceResponse)	Copy constructor
Public method	ServiceResponse<TData>(ResponseStatusEnum, String)	Parametric constructor for error cases
Public method	ServiceResponse<TData>(ResponseStatusEnum, String, TData)	Parametric constructor for error cases

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	Data	Payload
Public property	ScreenLockInterval	ScreenLock interval (Inherited from ServiceResponse.)
Public property	StatusCode	Status code (Inherited from ServiceResponse.)
Public property	StatusMessage	Status message (Inherited from ServiceResponse.)