IRESTResource Interface

REST resource metadata object.

Members

Name Description
Method AddOperation Adds child operation.
Method AddResource Adds child resource.
Method FindChildOperation Finds child operation, non-recursive.
Method FindChildResource Finds child resource, non-recursive.
Method GetOperations Returns enumerator for operations.
Method GetResources Returns enumerator for immediate child resources.
Read-only property IsCollection Specifies collection resource.
Write-only property IsCollection Specifies collection resource.
Read-only property IsDefaultCollection Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.
Write-only property IsDefaultCollection Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.
Read-only property IsStatic This flag marks resources that do not change over time.
Write-only property IsStatic This flag marks resources that do not change over time.
Read-only property Name Resource name. Used in IRESTRequestHandler's schema generation and url parsing.
Write-only property Name Resource name. Used in IRESTRequestHandler's schema generation and url parsing.
Write-only property RequiredCapability Required capability for the resource.
Read-only property RequiredCapability Required capability for the resource.
Write-only property SupportsETag This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.
Read-only property SupportsETag This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.
Method ToJSONObject Converts resource object to JSON representation.

IRESTResource.AddOperation Method

Adds child operation.

Public Sub AddOperation ( _
    ByVal o As IRESTOperation _
)
public void AddOperation (
    IRESTOperation o
);

IRESTResource.AddResource Method

Adds child resource.

Public Sub AddResource ( _
    ByVal r As IRESTResource _
)
public void AddResource (
    IRESTResource r
);

IRESTResource.FindChildOperation Method

Finds child operation, non-recursive.

Public Function FindChildOperation ( _
    ByVal Name As String _
) As IRESTOperation
public IRESTOperation FindChildOperation (
    string Name
);

IRESTResource.FindChildResource Method

Finds child resource, non-recursive.

Public Function FindChildResource ( _
    ByVal Name As String _
) As IRESTResource
public IRESTResource FindChildResource (
    string Name
);

IRESTResource.GetOperations Method

Returns enumerator for operations.

Public Function GetOperations ( _
) As IEnumRESTOperation
public IEnumRESTOperation GetOperations (
);

IRESTResource.GetResources Method

Returns enumerator for immediate child resources.

Public Function GetResources ( _
) As IEnumRESTResource
public IEnumRESTResource GetResources (
);

IRESTResource.IsCollection Property

Specifies collection resource.

Public Property IsCollection As Boolean
public bool IsCollection {get; set;}

IRESTResource.IsCollection Property

Specifies collection resource.

Public Property IsCollection As Boolean
public bool IsCollection {get; set;}

IRESTResource.IsDefaultCollection Property

Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.

Public Property IsDefaultCollection As Boolean
public bool IsDefaultCollection {get; set;}

IRESTResource.IsDefaultCollection Property

Specifies 'default' collection resource that can be accessed without explicitly using its name in the URL.

Public Property IsDefaultCollection As Boolean
public bool IsDefaultCollection {get; set;}

IRESTResource.IsStatic Property

This flag marks resources that do not change over time.

Public Property IsStatic As Boolean
public bool IsStatic {get; set;}

IRESTResource.IsStatic Property

This flag marks resources that do not change over time.

Public Property IsStatic As Boolean
public bool IsStatic {get; set;}

IRESTResource.Name Property

Resource name. Used in IRESTRequestHandler's schema generation and url parsing.

Public Property Name As String
public string Name {get; set;}

IRESTResource.Name Property

Resource name. Used in IRESTRequestHandler's schema generation and url parsing.

Public Property Name As String
public string Name {get; set;}

IRESTResource.RequiredCapability Property

Required capability for the resource.

Public Property RequiredCapability As String
public string RequiredCapability {get; set;}

IRESTResource.RequiredCapability Property

Required capability for the resource.

Public Property RequiredCapability As String
public string RequiredCapability {get; set;}

IRESTResource.SupportsETag Property

This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.

Public Property SupportsETag As Boolean
public bool SupportsETag {get; set;}

IRESTResource.SupportsETag Property

This flag is only for a root level resource. If this flag is true, IRRH implementation supports ETag.

Public Property SupportsETag As Boolean
public bool SupportsETag {get; set;}

IRESTResource.ToJSONObject Method

Converts resource object to JSON representation.

Public Function ToJSONObject ( _
) As IJSONObject
public IJSONObject ToJSONObject (
);

Classes that implement IRESTResource

Classes Description
CoRESTResource IRESTResource coclass

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.