|
4 | 4 | name: Client
|
5 | 5 | fullName: Client
|
6 | 6 | children:
|
7 |
| - - '@azure/service-bus.Client.constructor' |
8 | 7 | - '@azure/service-bus.Client.close'
|
| 8 | + - '@azure/service-bus.Client.detached' |
| 9 | + - '@azure/service-bus.Client.entityPath' |
9 | 10 | - '@azure/service-bus.Client.id'
|
10 |
| - - '@azure/service-bus.Client.name' |
11 | 11 | langs:
|
12 | 12 | - typeScript
|
13 |
| - type: class |
14 |
| - summary: Describes the base class for a client. |
| 13 | + type: interface |
| 14 | + summary: Interface for Queue/Topic/Subscription clients |
15 | 15 | package: '@azure/service-bus'
|
16 |
| - - uid: '@azure/service-bus.Client.constructor' |
17 |
| - name: 'Client(string, ConnectionContext)' |
| 16 | + - uid: '@azure/service-bus.Client.close' |
| 17 | + name: close() |
18 | 18 | children: []
|
19 |
| - type: constructor |
| 19 | + type: method |
20 | 20 | langs:
|
21 | 21 | - typeScript
|
22 |
| - summary: >- |
23 |
| - Instantiates a client pointing to the ServiceBus entity given by this |
24 |
| - configuration. |
| 22 | + summary: Closes the client. |
25 | 23 | syntax:
|
26 |
| - content: 'new Client(name: string, context: ConnectionContext)' |
27 |
| - parameters: |
28 |
| - - id: name |
29 |
| - type: |
30 |
| - - string |
31 |
| - description: The entity name. |
32 |
| - - id: context |
33 |
| - type: |
34 |
| - - '@azure/service-bus.ConnectionContext' |
35 |
| - description: The connection context to create the QueueClient. |
| 24 | + content: function close() |
| 25 | + parameters: [] |
| 26 | + return: |
| 27 | + type: |
| 28 | + - Promise<void> |
36 | 29 | package: '@azure/service-bus'
|
37 |
| - - uid: '@azure/service-bus.Client.close' |
38 |
| - name: close() |
| 30 | + - uid: '@azure/service-bus.Client.detached' |
| 31 | + name: detached(AmqpError | Error) |
39 | 32 | children: []
|
40 | 33 | type: method
|
41 | 34 | langs:
|
42 | 35 | - typeScript
|
43 |
| - summary: Closes the client. This is an abstract method. |
| 36 | + summary: Will reconnect the client if neccessary. |
44 | 37 | syntax:
|
45 |
| - content: function close() |
46 |
| - parameters: [] |
| 38 | + content: 'function detached(error?: AmqpError | Error)' |
| 39 | + parameters: |
| 40 | + - id: error |
| 41 | + type: |
| 42 | + - AmqpError | Error |
| 43 | + description: | |
| 44 | + Error if any |
| 45 | + optional: true |
47 | 46 | return:
|
48 | 47 | type:
|
49 | 48 | - Promise<void>
|
50 | 49 | package: '@azure/service-bus'
|
51 |
| - - uid: '@azure/service-bus.Client.id' |
52 |
| - name: id |
53 |
| - fullName: id |
| 50 | + - uid: '@azure/service-bus.Client.entityPath' |
| 51 | + name: entityPath |
| 52 | + fullName: entityPath |
54 | 53 | children: []
|
55 | 54 | langs:
|
56 | 55 | - typeScript
|
57 | 56 | type: property
|
58 | 57 | summary: >-
|
59 |
| - {string} id A unique identifier for the client. It is usually a |
60 |
| - combination of |
61 |
| -
|
62 |
| - the name and a Guid. |
| 58 | + {string} The entitypath for the Service Bus entity for which this client |
| 59 | + is created. |
63 | 60 | syntax:
|
64 |
| - content: 'id: string' |
| 61 | + content: 'entityPath: string' |
65 | 62 | return:
|
66 | 63 | type:
|
67 | 64 | - string
|
68 | 65 | package: '@azure/service-bus'
|
69 |
| - - uid: '@azure/service-bus.Client.name' |
70 |
| - name: name |
71 |
| - fullName: name |
| 66 | + - uid: '@azure/service-bus.Client.id' |
| 67 | + name: id |
| 68 | + fullName: id |
72 | 69 | children: []
|
73 | 70 | langs:
|
74 | 71 | - typeScript
|
75 | 72 | type: property
|
76 |
| - summary: '{string} name The name of the entity (queue, topic, subscription, etc.)' |
| 73 | + summary: '{string} A unique identifier for the client.' |
77 | 74 | syntax:
|
78 |
| - content: 'name: string' |
| 75 | + content: 'id: string' |
79 | 76 | return:
|
80 | 77 | type:
|
81 | 78 | - string
|
82 | 79 | package: '@azure/service-bus'
|
83 |
| -references: |
84 |
| - - uid: '@azure/service-bus.ConnectionContext' |
85 |
| - name: ConnectionContext |
86 |
| - spec.typeScript: |
87 |
| - - name: ConnectionContext |
88 |
| - fullName: ConnectionContext |
89 |
| - uid: '@azure/service-bus.ConnectionContext' |
0 commit comments