Class Application<TPrimitiveContent>

Inheritance

object

Application<TPrimitiveContent>

Namespace: Aetheros.OneM2M.Api

Assembly: Aetheros.OneM2M.Api.dll

Syntax

public class Application<TPrimitiveContent> where TPrimitiveContent : PrimitiveContent, new()

Type Parameters

Name	Description
TPrimitiveContent

Constructors

| Edit this page View Source

Application(Connection<TPrimitiveContent>, AE, string)

Declaration

public Application(Connection<TPrimitiveContent> con, AE ae, string urlPrefix)

Parameters

Type	Name	Description
Connection<TPrimitiveContent>	con
AE	ae
string	urlPrefix

Properties

| Edit this page View Source

Ae

Declaration

public AE Ae { get; }

Property Value

Type	Description
AE

| Edit this page View Source

AeId

Declaration

public string AeId { get; }

Property Value

Type	Description
string

| Edit this page View Source

Connection

Declaration

public Connection<TPrimitiveContent> Connection { get; }

Property Value

Type	Description
Connection<TPrimitiveContent>

| Edit this page View Source

CseId

Declaration

public string CseId { get; }

Property Value

Type	Description
string

Methods

| Edit this page View Source

AddContentInstanceAsync(string, object)

Declaration

public Task<ContentInstance> AddContentInstanceAsync(string key, object content)

Parameters

Type	Name	Description
string	key
object	content

Returns

Type	Description
Task<ContentInstance>

| Edit this page View Source

AddContentInstanceAsync(string, string?, object)

Declaration

public Task<ContentInstance> AddContentInstanceAsync(string key, string? resourceName, object content)

Parameters

Type	Name	Description
string	key
string	resourceName
object	content

Returns

Type	Description
Task<ContentInstance>

| Edit this page View Source

CreateResourceAsync(string, ResourceType, Func<TPrimitiveContent, TPrimitiveContent>, ResultContent?)

Declaration

public Task<ResponseContent<TPrimitiveContent>> CreateResourceAsync(string url, ResourceType resourceType, Func<TPrimitiveContent, TPrimitiveContent> setter, ResultContent? resultContent = null)

Parameters

Type	Name	Description
string	url
ResourceType	resourceType
Func<TPrimitiveContent, TPrimitiveContent>	setter
ResultContent?	resultContent

Returns

Type	Description
Task<ResponseContent<TPrimitiveContent>>

| Edit this page View Source

DeleteAsync(IEnumerable<string>)

Declaration

public Task DeleteAsync(IEnumerable<string> urls)

Parameters

Type	Name	Description
IEnumerable<string>	urls

Returns

Type	Description
Task

| Edit this page View Source

DeleteAsync(params string[])

Declaration

public Task DeleteAsync(params string[] urls)

Parameters

Type	Name	Description
string[]	urls

Returns

Type	Description
Task

| Edit this page View Source

EnsureContainerAsync(string, string?)

Declaration

public Task<Container?> EnsureContainerAsync(string name, string? aclUri = null)

Parameters

Type	Name	Description
string	name
string	aclUri

Returns

Type	Description
Task<Container>

| Edit this page View Source

FilterContentInstances<TContent>(IObservable<NotificationNotificationEvent<TPrimitiveContent>>)

Declaration

public IObservable<TContent> FilterContentInstances<TContent>(IObservable<NotificationNotificationEvent<TPrimitiveContent>> observable) where TContent : class

Parameters

Type	Name	Description
IObservable<NotificationNotificationEvent<TPrimitiveContent>>	observable

Returns

Type	Description
IObservable<TContent>

Type Parameters

Name	Description
TContent

| Edit this page View Source

GenerateSigningCertificateAsync(Uri, AE, string)

Declaration

public static Task<X509Certificate2> GenerateSigningCertificateAsync(Uri caUri, AE ae, string certificateFilename)

Parameters

Type	Name	Description
Uri	caUri
AE	ae
string	certificateFilename

Returns

Type	Description
Task<X509Certificate2>

| Edit this page View Source

GetChildResourcesAsync<T>(string, FilterCriteria?)

Declaration

public Task<T> GetChildResourcesAsync<T>(string key, FilterCriteria? filterCriteria = null) where T : class, new()

Parameters

Type	Name	Description
string	key
FilterCriteria	filterCriteria

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

GetLatestContentInstanceAsync<T>(string)

Declaration

public Task<T?> GetLatestContentInstanceAsync<T>(string containerKey) where T : class

Parameters

Type	Name	Description
string	containerKey

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

GetPrimitiveAsync(string, FilterCriteria?, ResultContent?, DiscResType?)

Declaration

public Task<ResponseContent<TPrimitiveContent>> GetPrimitiveAsync(string key, FilterCriteria? filterCriteria = null, ResultContent? resultContent = null, DiscResType? discoveryResultType = null)

Parameters

Type	Name	Description
string	key
FilterCriteria	filterCriteria
ResultContent?	resultContent
DiscResType?	discoveryResultType

Returns

Type	Description
Task<ResponseContent<TPrimitiveContent>>

| Edit this page View Source

GetResponseAsync(RequestPrimitive<TPrimitiveContent>)

Declaration

public Task<ResponseContent<TPrimitiveContent>> GetResponseAsync(RequestPrimitive<TPrimitiveContent> body)

Parameters

Type	Name	Description
RequestPrimitive<TPrimitiveContent>	body

Returns

Type	Description
Task<ResponseContent<TPrimitiveContent>>

| Edit this page View Source

GetResponseAsync<T>(RequestPrimitive<TPrimitiveContent>)

Declaration

public Task<T> GetResponseAsync<T>(RequestPrimitive<TPrimitiveContent> body) where T : class, new()

Parameters

Type	Name	Description
RequestPrimitive<TPrimitiveContent>	body

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

| Edit this page View Source

ObserveContentInstanceAsync<TContent>(string, string, string?, bool, int)

Declaration

public Task<IObservable<TContent>> ObserveContentInstanceAsync<TContent>(string containerName, string subscriptionName, string? poaUrl = null, bool deleteAfterFinalClose = false, int batchSize = 1) where TContent : class

Parameters

Type	Name	Description
string	containerName
string	subscriptionName
string	poaUrl
bool	deleteAfterFinalClose
int	batchSize

Returns

Type	Description
Task<IObservable<TContent>>

Type Parameters

Name	Description
TContent

| Edit this page View Source

ObserveNotificationAsync(string, string, EventNotificationCriteria?, string?, bool, int)

Creates a subscription to receive notifications from the server. The subscription is created on the resource specified by resourceId. The subscription is identified by the subscriptionName.

Declaration

public Task<IObservable<NotificationNotificationEvent<TPrimitiveContent>>> ObserveNotificationAsync(string resourceId, string subscriptionName, EventNotificationCriteria? criteria = null, string? poaUrl = null, bool deleteAfterFinalClose = false, int batchSize = 1)

Parameters

Type	Name	Description
string	resourceId	the resource (eg. Container) to subscribe to
string	subscriptionName	the unique name of the subscription
EventNotificationCriteria	criteria	allows filtering of notifications
string	poaUrl	overrides the AE's default POA URL
bool	deleteAfterFinalClose	if this is true, the subscription will be deleted after the returned observable is disposed
int	batchSize	enables batching of notifications in a single request

Returns

Type	Description
Task<IObservable<NotificationNotificationEvent<TPrimitiveContent>>>

Exceptions

Type	Condition
ProtocolViolationException

| Edit this page View Source

RegisterAsync(IConnectionConfiguration, ApplicationConfiguration, Uri?)

Declaration

public static Task<Application<TPrimitiveContent>> RegisterAsync(Connection.IConnectionConfiguration m2mConfig, ApplicationConfiguration appConfig, Uri? caUri = null)

Parameters

Type	Name	Description
Connection.IConnectionConfiguration	m2mConfig
ApplicationConfiguration	appConfig
Uri	caUri

Returns

Type	Description
Task<Application<TPrimitiveContent>>

| Edit this page View Source

ToAbsolute(string)

Declaration

public string ToAbsolute(string key)

Parameters

Type	Name	Description
string	key

Returns

Type	Description
string

| Edit this page View Source

TryGetPrimitiveAsync(string)

Declaration

public Task<ResponseContent<TPrimitiveContent>> TryGetPrimitiveAsync(string url)

Parameters

Type	Name	Description
string	url

Returns

Type	Description
Task<ResponseContent<TPrimitiveContent>>

| Edit this page View Source

UpdateResourceAsync(string, Func<TPrimitiveContent, TPrimitiveContent>)

Declaration

public Task<ResponseContent<TPrimitiveContent>> UpdateResourceAsync(string url, Func<TPrimitiveContent, TPrimitiveContent> setter)

Parameters

Type	Name	Description
string	url
Func<TPrimitiveContent, TPrimitiveContent>	setter

Returns

Type	Description
Task<ResponseContent<TPrimitiveContent>>