Class RestRequestStringBuilder

Namespace

TimeCockpit.Data.RequestHelper

Assembly

TimeCockpit.Data.dll

A class that is capable of build REST request.

public class RestRequestStringBuilder

Inheritance

Object

RestRequestStringBuilder

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Constructors

RestRequestStringBuilder(String)

Initializes a new instance of the RestRequestStringBuilder class.

public RestRequestStringBuilder(string serviceUrl)

Parameters

serviceUrl String

The service URL.

Properties

ExecuteActionUriTemplate

Gets the execute action URI template.

public string ExecuteActionUriTemplate { get; }

Property Value

String

ModelUriTemplate

Gets the model URI template.

public string ModelUriTemplate { get; }

Property Value

String

SaveChangesUriTemplate

Gets the save changes URI template.

public string SaveChangesUriTemplate { get; }

Property Value

String

ServiceUrl

Gets the service URL.

public string ServiceUrl { get; }

Property Value

String

Methods

CreateCurrentUserRequestUri()

Creates the template for fetching the current user

public string CreateCurrentUserRequestUri()

Returns

String

returns a uri request string for fetching the curren datacontext user.

CreateEntitiesBaseRequestUri()

creates the template for saving an entity object

public string CreateEntitiesBaseRequestUri()

Returns

String

returns a uri request string for saving an object.

CreateExecuteActionAsyncRequestUri(Boolean)

Creates the execute action async request URI.

public string CreateExecuteActionAsyncRequestUri(bool compress)

Parameters

compress Boolean

True if compression should be used, false otherwise.

Returns

String

returns the request uri for executeaction

CreatePostSelectByListNameAsyncRequestUri(Boolean)

creates the request uri for a SelectByListname.

public string CreatePostSelectByListNameAsyncRequestUri(bool compress)

Parameters

compress Boolean

true if compression should be used, false otherwise.

Returns

String

returns the uri request string.

CreatePostSelectTopAsyncRequestUri(Boolean)

creates the request uri for a select top with params.

public string CreatePostSelectTopAsyncRequestUri(bool compress)

Parameters

compress Boolean

true if compression should be used, false otherwise.

Returns

String

returns the uri request string.

CreateRefreshEnvironmentRequestUri()

Creates the uri for refresh an environment.

public string CreateRefreshEnvironmentRequestUri()

Returns

String

returns the uri to refresh the environment.

CreateRefreshNamedSetRequestUri(String)

Creates the uri for refreshing a namedset

public string CreateRefreshNamedSetRequestUri(string name)

Parameters

name String

The name of the set to refresh.

Returns

String

Returns a uri request string for refreshing a named set.

CreateSaveChangesAsyncRequestUri()

Creates a request uri for a save changes async method.

public string CreateSaveChangesAsyncRequestUri()

Returns

String

returns the request uri

CreateSelectSingleAsyncRequestUri(IEntityObject, Boolean, Boolean)

Creates a uri request string for a select single for a given entity object proxy descriptor

public string CreateSelectSingleAsyncRequestUri(IEntityObject entityObject, bool autoIncludeRelations, bool compress)

Parameters

entityObject IEntityObject

entity object proxy descriptor

autoIncludeRelations Boolean

true if relations should be included, false otherwise

compress Boolean

True if compression should be used, False otherwise.

Returns

String

returns the request uri.

CreateSignDownloadTokenRequestUri()

Creates the uri for signing a download token.

public string CreateSignDownloadTokenRequestUri()

Returns

String

returns the uri to sign a download token.