Opc.Ua.Gds.Client.Common.xml 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Opc.Ua.Gds.Client.Common</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventArgs">
  8. <summary>
  9. The arguments passed with a AdminCredentialsRequiredEventArgs event.
  10. </summary>
  11. </member>
  12. <member name="M:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventArgs.#ctor">
  13. <summary>
  14. Initializes a new instance of the <see cref="T:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventArgs"/> class.
  15. </summary>
  16. </member>
  17. <member name="P:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventArgs.Credentials">
  18. <summary>
  19. Gets or sets the credentials.
  20. </summary>
  21. </member>
  22. <member name="P:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventArgs.CacheCredentials">
  23. <summary>
  24. Gets or sets a flag indicating the credentials should be cached.
  25. </summary>
  26. </member>
  27. <member name="T:Opc.Ua.Gds.Client.AdminCredentialsRequiredEventHandler">
  28. <summary>
  29. A delegate used to handle AdminCredentialsRequired events.
  30. </summary>
  31. </member>
  32. <member name="T:Opc.Ua.Gds.Client.GlobalDiscoveryClientConfiguration">
  33. <summary>
  34. Stores the configuration the data access node manager.
  35. </summary>
  36. </member>
  37. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryClientConfiguration.#ctor">
  38. <summary>
  39. The default constructor.
  40. </summary>
  41. </member>
  42. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryClientConfiguration.Initialize(System.Runtime.Serialization.StreamingContext)">
  43. <summary>
  44. Initializes the object during deserialization.
  45. </summary>
  46. </member>
  47. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryClientConfiguration.Initialize">
  48. <summary>
  49. Sets private members to default values.
  50. </summary>
  51. </member>
  52. <member name="T:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient">
  53. <summary>
  54. A class that provides access to a Global Discovery Server.
  55. </summary>
  56. </member>
  57. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.#ctor(Opc.Ua.Configuration.ApplicationInstance,System.String,Opc.Ua.IUserIdentity)">
  58. <summary>
  59. Initializes a new instance of the <see cref="T:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient"/> class.
  60. </summary>
  61. <param name="application">The application.</param>
  62. <param name="endpointUrl">The endpoint Url.</param>
  63. <param name="adminUserIdentity">The user identity for the administrator.</param>
  64. </member>
  65. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Application">
  66. <summary>
  67. Gets the application.
  68. </summary>
  69. <value>
  70. The application.
  71. </value>
  72. </member>
  73. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.AdminCredentials">
  74. <summary>
  75. Gets or sets the admin credentials.
  76. </summary>
  77. <value>
  78. The admin credentials.
  79. </value>
  80. </member>
  81. <member name="E:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.AdminCredentialsRequired">
  82. <summary>
  83. Raised when admin credentials are required.
  84. </summary>
  85. </member>
  86. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Session">
  87. <summary>
  88. Gets the session.
  89. </summary>
  90. <value>
  91. The session.
  92. </value>
  93. </member>
  94. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.EndpointUrl">
  95. <summary>
  96. Gets or sets the endpoint URL.
  97. </summary>
  98. <value>
  99. The endpoint URL.
  100. </value>
  101. </member>
  102. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.PreferredLocales">
  103. <summary>
  104. Gets or sets the preferred locales.
  105. </summary>
  106. <value>
  107. The preferred locales.
  108. </value>
  109. </member>
  110. <member name="P:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.IsConnected">
  111. <summary>
  112. Gets a value indicating whether a session is connected.
  113. </summary>
  114. <value>
  115. <c>true</c> if [is connected]; otherwise, <c>false</c>.
  116. </value>
  117. </member>
  118. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetDefaultServerUrls(Opc.Ua.Gds.Client.LocalDiscoveryServerClient)">
  119. <summary>
  120. Returns list of servers known to the LDS, excluding GDS servers.
  121. </summary>
  122. <param name="lds">The LDS to use.</param>
  123. <returns>
  124. TRUE if successful; FALSE otherwise.
  125. </returns>
  126. </member>
  127. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetDefaultGdsUrls(Opc.Ua.Gds.Client.LocalDiscoveryServerClient)">
  128. <summary>
  129. Returns list of GDS servers known to the LDS.
  130. </summary>
  131. <param name="lds">The LDS to use.</param>
  132. <returns>
  133. TRUE if successful; FALSE otherwise.
  134. </returns>
  135. </member>
  136. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Connect">
  137. <summary>
  138. Connects using the default endpoint.
  139. </summary>
  140. </member>
  141. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Connect(System.String)">
  142. <summary>
  143. Connects the specified endpoint URL.
  144. </summary>
  145. <param name="endpointUrl">The endpoint URL.</param>
  146. <exception cref="T:System.ArgumentNullException">endpointUrl</exception>
  147. <exception cref="T:System.ArgumentException">endpointUrl</exception>
  148. </member>
  149. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Connect(Opc.Ua.ConfiguredEndpoint)">
  150. <summary>
  151. Connects the specified endpoint.
  152. </summary>
  153. <param name="endpoint">The endpoint.</param>
  154. </member>
  155. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.Disconnect">
  156. <summary>
  157. Disconnect the client connection.
  158. </summary>
  159. </member>
  160. <member name="E:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.KeepAlive">
  161. <summary>
  162. Occurs when keep alive occurs.
  163. </summary>
  164. </member>
  165. <member name="E:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.ServerStatusChanged">
  166. <summary>
  167. Occurs when the server status changes.
  168. </summary>
  169. </member>
  170. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.FindApplication(System.String)">
  171. <summary>
  172. Finds the applications with the specified application uri.
  173. </summary>
  174. <param name="applicationUri">The application URI.</param>
  175. <returns>The matching application.</returns>
  176. </member>
  177. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.QueryServers(System.UInt32,System.String,System.String,System.String,System.Collections.Generic.IList{System.String})">
  178. <summary>
  179. Queries the GDS for any servers matching the criteria.
  180. </summary>
  181. <param name="maxRecordsToReturn">The max records to return.</param>
  182. <param name="applicationName">The filter applied to the application name.</param>
  183. <param name="applicationUri">The filter applied to the application uri.</param>
  184. <param name="productUri">The filter applied to the product uri.</param>
  185. <param name="serverCapabilities">The filter applied to the server capabilities.</param>
  186. <returns>A enumarator used to access the results.</returns>
  187. </member>
  188. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.QueryServers(System.UInt32,System.UInt32,System.String,System.String,System.String,System.Collections.Generic.IList{System.String})">
  189. <summary>
  190. Queries the GDS for any servers matching the criteria.
  191. </summary>
  192. <param name="startingRecordId">The id of the first record to return.</param>
  193. <param name="maxRecordsToReturn">The max records to return.</param>
  194. <param name="applicationName">The filter applied to the application name.</param>
  195. <param name="applicationUri">The filter applied to the application uri.</param>
  196. <param name="productUri">The filter applied to the product uri.</param>
  197. <param name="serverCapabilities">The filter applied to the server capabilities.</param>
  198. <returns>A enumerator used to access the results.</returns>
  199. </member>
  200. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.QueryServers(System.UInt32,System.UInt32,System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.DateTime@)">
  201. <summary>
  202. Queries the GDS for any servers matching the criteria.
  203. </summary>
  204. <param name="startingRecordId">The id of the first record to return.</param>
  205. <param name="maxRecordsToReturn">The max records to return.</param>
  206. <param name="applicationName">The filter applied to the application name.</param>
  207. <param name="applicationUri">The filter applied to the application uri.</param>
  208. <param name="productUri">The filter applied to the product uri.</param>
  209. <param name="serverCapabilities">The filter applied to the server capabilities.</param>
  210. <param name="lastCounterResetTime">The time when the counter was last changed.</param>
  211. <returns>A enumerator used to access the results.</returns>
  212. </member>
  213. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.QueryApplications(System.UInt32,System.UInt32,System.String,System.String,System.UInt32,System.String,System.Collections.Generic.IList{System.String},System.DateTime@,System.UInt32@)">
  214. <summary>
  215. Queries the GDS for any servers matching the criteria.
  216. </summary>
  217. <param name="startingRecordId">The id of the first record to return.</param>
  218. <param name="maxRecordsToReturn">The max records to return.</param>
  219. <param name="applicationName">The filter applied to the application name.</param>
  220. <param name="applicationUri">The filter applied to the application uri.</param>
  221. <param name="applicationType">The filter applied to the application uri.</param>
  222. <param name="productUri">The filter applied to the product uri.</param>
  223. <param name="serverCapabilities">The filter applied to the server capabilities.</param>
  224. <param name="lastCounterResetTime">The time when the counter was last changed.</param>
  225. <param name="nextRecordId">The id of the next record.</param>
  226. <returns>A enumerator used to access the results.</returns>
  227. </member>
  228. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetApplication(Opc.Ua.NodeId)">
  229. <summary>
  230. Get the application record.
  231. </summary>
  232. <param name="applicationId">The application id.</param>
  233. <returns>The application record for the specified application id.</returns>
  234. </member>
  235. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.RegisterApplication(Opc.Ua.Gds.ApplicationRecordDataType)">
  236. <summary>
  237. Registers the application.
  238. </summary>
  239. <param name="application">The application.</param>
  240. <returns>The application id assigned to the application.</returns>
  241. </member>
  242. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.UpdateApplication(Opc.Ua.Gds.ApplicationRecordDataType)">
  243. <summary>
  244. Updates the application.
  245. </summary>
  246. <param name="application">The application.</param>
  247. </member>
  248. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.UnregisterApplication(Opc.Ua.NodeId)">
  249. <summary>
  250. Unregisters the application.
  251. </summary>
  252. <param name="applicationId">The application id.</param>
  253. </member>
  254. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.StartNewKeyPairRequest(Opc.Ua.NodeId,Opc.Ua.NodeId,Opc.Ua.NodeId,System.String,System.Collections.Generic.IList{System.String},System.String,System.String)">
  255. <summary>
  256. Requests a new certificate.
  257. </summary>
  258. <param name="applicationId">The application id.</param>
  259. <param name="certificateGroupId">The authority.</param>
  260. <param name="certificateTypeId">Type of the certificate.</param>
  261. <param name="subjectName">Name of the subject.</param>
  262. <param name="domainNames">The domain names.</param>
  263. <param name="privateKeyFormat">The private key format (PEM or PFX).</param>
  264. <param name="privateKeyPassword">The private key password.</param>
  265. <returns>
  266. The id for the request which is used to check when it is approved.
  267. </returns>
  268. </member>
  269. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.StartSigningRequest(Opc.Ua.NodeId,Opc.Ua.NodeId,Opc.Ua.NodeId,System.Byte[])">
  270. <summary>
  271. Signs the certificate.
  272. </summary>
  273. <param name="applicationId">The application id.</param>
  274. <param name="certificateGroupId">The group of the trust list.</param>
  275. <param name="certificateTypeId">The type of the trust list.</param>
  276. <param name="certificateRequest">The certificate signing request (CSR).</param>
  277. <returns>The id for the request which is used to check when it is approved.</returns>
  278. </member>
  279. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.FinishRequest(Opc.Ua.NodeId,Opc.Ua.NodeId,System.Byte[]@,System.Byte[][]@)">
  280. <summary>
  281. Checks the request status.
  282. </summary>
  283. <param name="applicationId">The application id.</param>
  284. <param name="requestId">The request id.</param>
  285. <param name="privateKey">The private key.</param>
  286. <param name="issuerCertificates">The issuer certificates.</param>
  287. <returns>The public key.</returns>
  288. </member>
  289. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetCertificateGroups(Opc.Ua.NodeId)">
  290. <summary>
  291. Gets the certificate groups.
  292. </summary>
  293. <param name="applicationId">The application id.</param>
  294. <returns></returns>
  295. </member>
  296. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetTrustList(Opc.Ua.NodeId,Opc.Ua.NodeId)">
  297. <summary>
  298. Gets the trust lists method.
  299. </summary>
  300. <param name="applicationId">The application id.</param>
  301. <param name="certificateGroupId">Type of the trust list.</param>
  302. <returns></returns>
  303. </member>
  304. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.GetCertificateStatus(Opc.Ua.NodeId,Opc.Ua.NodeId,Opc.Ua.NodeId)">
  305. <summary>
  306. Gets the certificate status.
  307. </summary>
  308. <param name="applicationId">The application id.</param>
  309. <param name="certificateGroupId">Group of the trust list.</param>
  310. <param name="certificateTypeId">Type of the trust list.</param>
  311. <returns></returns>
  312. </member>
  313. <member name="M:Opc.Ua.Gds.Client.GlobalDiscoveryServerClient.ReadTrustList(Opc.Ua.NodeId)">
  314. <summary>
  315. Reads the trust list.
  316. </summary>
  317. </member>
  318. <member name="T:Opc.Ua.Gds.Client.RegisteredApplication">
  319. <remarks/>
  320. </member>
  321. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ApplicationUri">
  322. <remarks/>
  323. </member>
  324. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ApplicationName">
  325. <remarks/>
  326. </member>
  327. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ProductUri">
  328. <remarks/>
  329. </member>
  330. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.DiscoveryUrl">
  331. <remarks/>
  332. </member>
  333. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ServerCapability">
  334. <remarks/>
  335. </member>
  336. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ConfigurationFile">
  337. <remarks/>
  338. </member>
  339. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.ServerUrl">
  340. <remarks/>
  341. </member>
  342. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.CertificateStorePath">
  343. <remarks/>
  344. </member>
  345. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.CertificateSubjectName">
  346. <remarks/>
  347. </member>
  348. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.CertificatePublicKeyPath">
  349. <remarks/>
  350. </member>
  351. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.CertificatePrivateKeyPath">
  352. <remarks/>
  353. </member>
  354. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.TrustListStorePath">
  355. <remarks/>
  356. </member>
  357. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.IssuerListStorePath">
  358. <remarks/>
  359. </member>
  360. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.HttpsCertificatePublicKeyPath">
  361. <remarks/>
  362. </member>
  363. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.HttpsCertificatePrivateKeyPath">
  364. <remarks/>
  365. </member>
  366. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.HttpsTrustListStorePath">
  367. <remarks/>
  368. </member>
  369. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.HttpsIssuerListStorePath">
  370. <remarks/>
  371. </member>
  372. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.CertificateRequestId">
  373. <remarks/>
  374. </member>
  375. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.Domains">
  376. <remarks/>
  377. </member>
  378. <member name="P:Opc.Ua.Gds.Client.RegisteredApplication.RegistrationType">
  379. <remarks/>
  380. </member>
  381. <member name="M:Opc.Ua.Gds.Client.RegisteredApplication.GetHttpsDomainName">
  382. <summary>
  383. Gets the name of the HTTPS domain for the application.
  384. </summary>
  385. <returns></returns>
  386. </member>
  387. <member name="T:Opc.Ua.Gds.Client.RegistrationType">
  388. <remarks/>
  389. </member>
  390. <member name="F:Opc.Ua.Gds.Client.RegistrationType.ClientPull">
  391. <remarks/>
  392. </member>
  393. <member name="F:Opc.Ua.Gds.Client.RegistrationType.ServerPull">
  394. <remarks/>
  395. </member>
  396. <member name="F:Opc.Ua.Gds.Client.RegistrationType.ServerPush">
  397. <remarks/>
  398. </member>
  399. <member name="T:Opc.Ua.Gds.Client.ServerCapabilities">
  400. <summary>
  401. The set known capability identifiers.
  402. </summary>
  403. </member>
  404. <member name="M:Opc.Ua.Gds.Client.ServerCapabilities.#ctor">
  405. <summary>
  406. Initializes a new instance of the <see cref="T:Opc.Ua.Gds.Client.ServerCapabilities"/> class.
  407. </summary>
  408. </member>
  409. <member name="M:Opc.Ua.Gds.Client.ServerCapabilities.Load">
  410. <summary>
  411. Loads the default set of server capability identifiers.
  412. </summary>
  413. </member>
  414. <member name="M:Opc.Ua.Gds.Client.ServerCapabilities.Load(System.IO.Stream)">
  415. <summary>
  416. Loads the set of server capability identifiers from the stream.
  417. </summary>
  418. <param name="istrm">The input stream.</param>
  419. </member>
  420. <member name="M:Opc.Ua.Gds.Client.ServerCapabilities.Find(System.String)">
  421. <summary>
  422. Finds the sever capability with the specified identifier.
  423. </summary>
  424. <param name="id">The identifier.</param>
  425. <returns>The sever capability, if found. NULL if it does not exist.</returns>
  426. </member>
  427. <member name="T:Opc.Ua.Gds.Client.ServerCapability">
  428. <summary>
  429. A server capability.
  430. </summary>
  431. </member>
  432. <member name="P:Opc.Ua.Gds.Client.ServerCapability.Id">
  433. <summary>
  434. Gets or sets the identifier.
  435. </summary>
  436. <value>
  437. The identifier.
  438. </value>
  439. </member>
  440. <member name="P:Opc.Ua.Gds.Client.ServerCapability.Description">
  441. <summary>
  442. Gets or sets the description.
  443. </summary>
  444. <value>
  445. The description.
  446. </value>
  447. </member>
  448. <member name="M:Opc.Ua.Gds.Client.ServerCapability.ToString">
  449. <summary>
  450. Returns a <see cref="T:System.String" /> that represents this instance.
  451. </summary>
  452. <returns>
  453. A <see cref="T:System.String" /> that represents this instance.
  454. </returns>
  455. </member>
  456. <member name="M:Opc.Ua.Gds.Client.ServerCapability.ToString(System.String,System.IFormatProvider)">
  457. <summary>
  458. Returns a <see cref="T:System.String" /> that represents this instance.
  459. </summary>
  460. <param name="format">The format.</param>
  461. <param name="formatProvider">The format provider.</param>
  462. <returns>
  463. A <see cref="T:System.String" /> that represents this instance.
  464. </returns>
  465. </member>
  466. <member name="F:Opc.Ua.Gds.Client.ServerCapability.NoInformation">
  467. <summary>
  468. No information is available.
  469. </summary>
  470. </member>
  471. <member name="F:Opc.Ua.Gds.Client.ServerCapability.LiveData">
  472. <summary>
  473. The server supports live data.
  474. </summary>
  475. </member>
  476. <member name="F:Opc.Ua.Gds.Client.ServerCapability.AlarmsAndConditions">
  477. <summary>
  478. The server supports alarms and conditions
  479. </summary>
  480. </member>
  481. <member name="F:Opc.Ua.Gds.Client.ServerCapability.HistoricalData">
  482. <summary>
  483. The server supports historical data.
  484. </summary>
  485. </member>
  486. <member name="F:Opc.Ua.Gds.Client.ServerCapability.HistoricalEvents">
  487. <summary>
  488. The server supports historical events.
  489. </summary>
  490. </member>
  491. <member name="F:Opc.Ua.Gds.Client.ServerCapability.GlobalDiscoveryServer">
  492. <summary>
  493. The server is a global discovery server.
  494. </summary>
  495. </member>
  496. <member name="F:Opc.Ua.Gds.Client.ServerCapability.LocalDiscoveryServer">
  497. <summary>
  498. The server is a local discovery server.
  499. </summary>
  500. </member>
  501. <member name="F:Opc.Ua.Gds.Client.ServerCapability.DI">
  502. <summary>
  503. The server supports the data integration (DI) information model.
  504. </summary>
  505. </member>
  506. <member name="T:Opc.Ua.Gds.Client.ServerPushConfigurationClient">
  507. <summary>
  508. A class used to access the Push Configuration information model.
  509. </summary>
  510. </member>
  511. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.#ctor(Opc.Ua.Configuration.ApplicationInstance)">
  512. <summary>
  513. Initializes a new instance of the <see cref="T:Opc.Ua.Gds.Client.ServerPushConfigurationClient"/> class.
  514. </summary>
  515. <param name="application">The application.</param>
  516. </member>
  517. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Application">
  518. <summary>
  519. Gets the application instance.
  520. </summary>
  521. <value>
  522. The application instance.
  523. </value>
  524. </member>
  525. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.AdminCredentials">
  526. <summary>
  527. Gets or sets the admin credentials.
  528. </summary>
  529. <value>
  530. The admin credentials.
  531. </value>
  532. </member>
  533. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.EndpointUrl">
  534. <summary>
  535. Gets or sets the endpoint URL.
  536. </summary>
  537. <value>
  538. The endpoint URL.
  539. </value>
  540. </member>
  541. <member name="E:Opc.Ua.Gds.Client.ServerPushConfigurationClient.AdminCredentialsRequired">
  542. <summary>
  543. Raised when admin credentials are required.
  544. </summary>
  545. </member>
  546. <member name="E:Opc.Ua.Gds.Client.ServerPushConfigurationClient.ConnectionStatusChanged">
  547. <summary>
  548. Raised when the connection status changes.
  549. </summary>
  550. </member>
  551. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.PreferredLocales">
  552. <summary>
  553. Gets or sets the preferred locales.
  554. </summary>
  555. <value>
  556. The preferred locales.
  557. </value>
  558. </member>
  559. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.IsConnected">
  560. <summary>
  561. Gets a value indicating whether the session is connected.
  562. </summary>
  563. <value>
  564. <c>true</c> if the session is connected; otherwise, <c>false</c>.
  565. </value>
  566. </member>
  567. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Session">
  568. <summary>
  569. Gets the session.
  570. </summary>
  571. <value>
  572. The session.
  573. </value>
  574. </member>
  575. <member name="P:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Endpoint">
  576. <summary>
  577. Gets the endpoint.
  578. </summary>
  579. <value>
  580. The endpoint.
  581. </value>
  582. </member>
  583. <member name="E:Opc.Ua.Gds.Client.ServerPushConfigurationClient.KeepAlive">
  584. <summary>
  585. Occurs when keep alive occurs.
  586. </summary>
  587. </member>
  588. <member name="E:Opc.Ua.Gds.Client.ServerPushConfigurationClient.ServerStatusChanged">
  589. <summary>
  590. Occurs when the server status changes.
  591. </summary>
  592. </member>
  593. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Connect">
  594. <summary>
  595. Connects using the default endpoint.
  596. </summary>
  597. </member>
  598. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Connect(System.String)">
  599. <summary>
  600. Connects the specified endpoint URL.
  601. </summary>
  602. <param name="endpointUrl">The endpoint URL.</param>
  603. <exception cref="T:System.ArgumentNullException">endpointUrl</exception>
  604. <exception cref="T:System.ArgumentException">endpointUrl</exception>
  605. </member>
  606. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Connect(Opc.Ua.ConfiguredEndpoint)">
  607. <summary>
  608. Connects the specified endpoint.
  609. </summary>
  610. <param name="endpoint">The endpoint.</param>
  611. </member>
  612. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.Disconnect">
  613. <summary>
  614. Disconnects this instance.
  615. </summary>
  616. </member>
  617. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.GetSupportedKeyFormats">
  618. <summary>
  619. Gets the supported key formats.
  620. </summary>
  621. <exception cref="T:System.InvalidOperationException">Connection to server is not active.</exception>
  622. </member>
  623. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.ReadTrustList(Opc.Ua.TrustListMasks)">
  624. <summary>
  625. Reads the trust list.
  626. </summary>
  627. </member>
  628. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.UpdateTrustList(Opc.Ua.TrustListDataType)">
  629. <summary>
  630. Updates the trust list.
  631. </summary>
  632. </member>
  633. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.AddCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean)">
  634. <summary>
  635. Add certificate.
  636. </summary>
  637. </member>
  638. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.AddCrl(Opc.Ua.Security.Certificates.X509CRL,System.Boolean)">
  639. <summary>
  640. Add certificate.
  641. </summary>
  642. </member>
  643. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.RemoveCertificate(System.String,System.Boolean)">
  644. <summary>
  645. Remove certificate.
  646. </summary>
  647. </member>
  648. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.CreateSigningRequest(Opc.Ua.NodeId,Opc.Ua.NodeId,System.String,System.Boolean,System.Byte[])">
  649. <summary>
  650. Creates the CSR.
  651. </summary>
  652. <param name="certificateGroupId">The certificate group identifier.</param>
  653. <param name="certificateTypeId">The certificate type identifier.</param>
  654. <param name="subjectName">Name of the subject.</param>
  655. <param name="regeneratePrivateKey">if set to <c>true</c> [regenerate private key].</param>
  656. <param name="nonce">The nonce.</param>
  657. <returns></returns>
  658. </member>
  659. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.UpdateCertificate(Opc.Ua.NodeId,Opc.Ua.NodeId,System.Byte[],System.String,System.Byte[],System.Byte[][])">
  660. <summary>
  661. Updates the certificate.
  662. </summary>
  663. <param name="certificateGroupId">The group of the trust list.</param>
  664. <param name="certificateTypeId">The type of the trust list.</param>
  665. <param name="certificate">The certificate.</param>
  666. <param name="privateKeyFormat">The format of the private key, PFX or PEM.</param>
  667. <param name="privateKey">The private ky.</param>
  668. <param name="issuerCertificates">An array containing the chain of issuer certificates.</param>
  669. </member>
  670. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.GetRejectedList">
  671. <summary>
  672. Reads the rejected list.
  673. </summary>
  674. </member>
  675. <member name="M:Opc.Ua.Gds.Client.ServerPushConfigurationClient.ApplyChanges">
  676. <summary>
  677. Restarts this instance.
  678. </summary>
  679. </member>
  680. </members>
  681. </doc>