NLWdmClient

概要

継承

継承元: NSObject

プロパティ
`name`	`NSString *`
`owner`	`id`
`resultCallbackQueue`	`dispatch_queue_t`

パブリック関数
`NS_UNAVAILABLE()`	`virtual instancetype` NSObject から継承されたデフォルトのイニシャライザを無効にします。
`close:(WdmClientCompletionBlock completionHandler)`	`virtual void` すべてのリソースを強制的に解放し、すべての参照を破棄します。
`flushUpdate:failure:(WdmClientCompletionBlock completionHandler, WdmClientFailureBlock failureHandler)`	`virtual void` すべてのトレイトデータのフラッシュを開始します。
`getDataSink:(long long traitInstancePtr)`	`virtual NLGenericTraitUpdatableDataSink *`
`init:weaveWorkQueue:appCallbackQueue:exchangeMgr:messageLayer:nlWeaveDeviceManager:(NSString name, dispatch_queue_t weaveWorkQueue, dispatch_queue_t appCallbackQueue, nl::Weave::WeaveExchangeManager exchangeMgr, nl::Weave::WeaveMessageLayer messageLayer, NLWeaveDeviceManager NS_DESIGNATED_INITIALIZER)`	`virtual instancetype`
`newDataSink:profileId:instanceId:path:(NLResourceIdentifier nlResourceIdentifier, uint32_t profileId, uint64_t instanceId, NSString path)`	`virtual NLGenericTraitUpdatableDataSink *` 新しいデータ newDataSink を作成します。
`refreshData:failure:(WdmClientCompletionBlock completionHandler, WdmClientFailureBlock failureHandler)`	`virtual void` すべてのトレイトデータの同期を開始します。
`removeDataSinkRef:(long long traitInstancePtr)`	`virtual void`
`setNodeId:(uint64_t nodeId)`	`virtual void` WdmClient のトレイトカタログで Weave ノード ID を設定
`statusReportToString:statusCode:(NSUInteger profileId, NSInteger statusCode)`	`virtual NSString *`
`toErrorString:(WEAVE_ERROR err)`	`virtual NSString *`

プロパティ

name

NSString * name

オーナー

id owner

resultCallbackQueue

dispatch_queue_t resultCallbackQueue

パブリック関数

NS_UNAVAILABLE

virtual instancetype NS_UNAVAILABLE()

NSObject から継承されたデフォルトのイニシャライザを無効にします。

Close:

virtual void close:(
  WdmClientCompletionBlock completionHandler
)

すべてのリソースを強制的に解放し、すべての参照を破棄します。

この呼び出しの後にこの WDMClient を復活させる方法はありません。

flushUpdate:failure:

virtual void flushUpdate:failure:(
  WdmClientCompletionBlock completionHandler,
  WdmClientFailureBlock failureHandler
)

すべてのトレイトデータのフラッシュを開始します。

このオペレーションの結果は CompleteHandler と failureHandler で確認できます。操作が完了すると、onWdmClientFlushUpdateComplete が呼び出され、アプリケーションは statusResultsList を受け取ります。空の場合、これはパスに失敗したことがないことを意味します。内部で、配列メンバーは NLWdmClientFlushUpdateError(local client error) または NLWdmClientFlushDeviceStatus(remote device status) であることができ、必要なデータパスから特定のエラーのデータがスキップされ、必要な場合は、アプリはデータを使用できます。オペレーションが失敗すると、通常はオペレーションがまったく完了できないことを意味します。たとえば、通信やプロトコルに問題がある場合は、onWdmClientError が呼び出されます。

getDataSink:

virtual NLGenericTraitUpdatableDataSink * getDataSink:(
  long long traitInstancePtr
)

init:weaveWorkQueue:appCallbackQueue:exchangeMgr:messageLayer:nlWeaveDeviceManager:

virtual instancetype init:weaveWorkQueue:appCallbackQueue:exchangeMgr:messageLayer:nlWeaveDeviceManager:(
  NSString *name,
  dispatch_queue_t weaveWorkQueue,
  dispatch_queue_t appCallbackQueue,
  nl::Weave::WeaveExchangeManager *exchangeMgr,
  nl::Weave::WeaveMessageLayer *messageLayer,
  NLWeaveDeviceManager *NS_DESIGNATED_INITIALIZER
)

newDataSink:profileId:instanceId:path:

virtual NLGenericTraitUpdatableDataSink * newDataSink:profileId:instanceId:path:(
  NLResourceIdentifier *nlResourceIdentifier,
  uint32_t profileId,
  uint64_t instanceId,
  NSString *path
)

新しいデータ newDataSink を作成します。

詳細

パラメータ

`nlResourceIdentifier`	リソース ID は、Weave リソースのグローバルに一意の識別子です。
`profileId`	トレイトプロフィール ID
`instanceId`	トレイトインスタンス ID
`path`	トレイトパス

refreshData:failure:

virtual void refreshData:failure:(
  WdmClientCompletionBlock completionHandler,
  WdmClientFailureBlock failureHandler
)

すべてのトレイトデータの同期を開始します。

このオペレーションの結果は、CompleteHandler と failureHandler で監視できます。

removeDataSinkRef:

virtual void removeDataSinkRef:(
  long long traitInstancePtr
)

setNodeId:

virtual void setNodeId:(
  uint64_t nodeId
)

WdmClient のトレイトカタログで Weave ノード ID を設定

詳細

パラメータ

nodeId

Weave ノード ID

statusReportToString:statusCode:

virtual NSString * statusReportToString:statusCode:(
  NSUInteger profileId,
  NSInteger statusCode
)

toErrorString:

virtual NSString * toErrorString:(
  WEAVE_ERROR err
)