|
2 | 2 |
|
3 | 3 | # Class: Actions |
4 | 4 |
|
| 5 | +Defined in: [src/core/Actions.ts:46](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L46) |
| 6 | + |
5 | 7 | ## Constructors |
6 | 8 |
|
7 | | -### new Actions() |
| 9 | +### Constructor |
8 | 10 |
|
9 | | -> **new Actions**(`session`): [`Actions`](Actions.md) |
| 11 | +> **new Actions**(`session`): `Actions` |
10 | 12 |
|
11 | | -#### Parameters |
| 13 | +Defined in: [src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L49) |
12 | 14 |
|
13 | | -• **session**: [`Session`](Session.md) |
| 15 | +#### Parameters |
14 | 16 |
|
15 | | -#### Returns |
| 17 | +##### session |
16 | 18 |
|
17 | | -[`Actions`](Actions.md) |
| 19 | +[`Session`](Session.md) |
18 | 20 |
|
19 | | -#### Defined in |
| 21 | +#### Returns |
20 | 22 |
|
21 | | -[src/core/Actions.ts:49](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L49) |
| 23 | +`Actions` |
22 | 24 |
|
23 | 25 | ## Properties |
24 | 26 |
|
25 | 27 | ### session |
26 | 28 |
|
27 | 29 | > **session**: [`Session`](Session.md) |
28 | 30 |
|
29 | | -#### Defined in |
30 | | - |
31 | | -[src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L47) |
| 31 | +Defined in: [src/core/Actions.ts:47](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L47) |
32 | 32 |
|
33 | 33 | ## Methods |
34 | 34 |
|
35 | 35 | ### execute() |
36 | 36 |
|
37 | | -#### execute(endpoint, args) |
| 37 | +#### Call Signature |
38 | 38 |
|
39 | 39 | > **execute**\<`T`\>(`endpoint`, `args`): `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\> |
40 | 40 |
|
| 41 | +Defined in: [src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L81) |
| 42 | + |
41 | 43 | Executes an API call. |
42 | 44 |
|
43 | 45 | ##### Type Parameters |
44 | 46 |
|
45 | | -• **T** *extends* `string` |
| 47 | +###### T |
| 48 | + |
| 49 | +`T` *extends* `string` |
46 | 50 |
|
47 | 51 | ##### Parameters |
48 | 52 |
|
49 | | -• **endpoint**: `T` |
| 53 | +###### endpoint |
| 54 | + |
| 55 | +`T` |
50 | 56 |
|
51 | 57 | The endpoint to call. |
52 | 58 |
|
53 | | -• **args** |
| 59 | +###### args |
54 | 60 |
|
55 | 61 | Call arguments |
56 | 62 |
|
57 | | -• **args.parse**: `true` |
| 63 | +###### parse |
| 64 | + |
| 65 | +`true` |
| 66 | + |
| 67 | +###### protobuf? |
| 68 | + |
| 69 | +`false` |
58 | 70 |
|
59 | | -• **args.protobuf?**: `false` |
| 71 | +###### serialized_data? |
60 | 72 |
|
61 | | -• **args.serialized\_data?**: `any` |
| 73 | +`any` |
62 | 74 |
|
63 | | -• **args.skip\_auth\_check?**: `boolean` |
| 75 | +###### skip_auth_check? |
| 76 | + |
| 77 | +`boolean` |
64 | 78 |
|
65 | 79 | ##### Returns |
66 | 80 |
|
67 | 81 | `Promise`\<[`ParsedResponse`](../type-aliases/ParsedResponse.md)\<`T`\>\> |
68 | 82 |
|
69 | | -##### Defined in |
| 83 | +#### Call Signature |
70 | 84 |
|
71 | | -[src/core/Actions.ts:81](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L81) |
| 85 | +> **execute**\<`T`\>(`endpoint`, `args?`): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> |
72 | 86 |
|
73 | | -#### execute(endpoint, args) |
| 87 | +Defined in: [src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L88) |
74 | 88 |
|
75 | | -> **execute**\<`T`\>(`endpoint`, `args`?): `Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> |
| 89 | +Executes an API call. |
76 | 90 |
|
77 | 91 | ##### Type Parameters |
78 | 92 |
|
79 | | -• **T** *extends* `string` |
| 93 | +###### T |
| 94 | + |
| 95 | +`T` *extends* `string` |
80 | 96 |
|
81 | 97 | ##### Parameters |
82 | 98 |
|
83 | | -• **endpoint**: `T` |
| 99 | +###### endpoint |
| 100 | + |
| 101 | +`T` |
84 | 102 |
|
85 | | -• **args?** |
| 103 | +The endpoint to call. |
86 | 104 |
|
87 | | -• **args.parse?**: `false` |
| 105 | +###### args? |
88 | 106 |
|
89 | | -• **args.protobuf?**: `true` |
| 107 | +Call arguments |
90 | 108 |
|
91 | | -• **args.serialized\_data?**: `any` |
| 109 | +###### parse? |
92 | 110 |
|
93 | | -• **args.skip\_auth\_check?**: `boolean` |
| 111 | +`false` |
94 | 112 |
|
95 | | -##### Returns |
| 113 | +###### protobuf? |
96 | 114 |
|
97 | | -`Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> |
| 115 | +`true` |
| 116 | + |
| 117 | +###### serialized_data? |
| 118 | + |
| 119 | +`any` |
| 120 | + |
| 121 | +###### skip_auth_check? |
| 122 | + |
| 123 | +`boolean` |
98 | 124 |
|
99 | | -##### Defined in |
| 125 | +##### Returns |
100 | 126 |
|
101 | | -[src/core/Actions.ts:88](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L88) |
| 127 | +`Promise`\<[`ApiResponse`](../interfaces/ApiResponse.md)\> |
102 | 128 |
|
103 | 129 | *** |
104 | 130 |
|
105 | 131 | ### stats() |
106 | 132 |
|
107 | 133 | > **stats**(`url`, `client`, `params`): `Promise`\<`Response`\> |
108 | 134 |
|
| 135 | +Defined in: [src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/41b810629b3dc2bbebfa322c0c452c3f7303e993/src/core/Actions.ts#L59) |
| 136 | + |
109 | 137 | Makes calls to the playback tracking API. |
110 | 138 |
|
111 | 139 | #### Parameters |
112 | 140 |
|
113 | | -• **url**: `string` |
| 141 | +##### url |
| 142 | + |
| 143 | +`string` |
114 | 144 |
|
115 | 145 | The URL to call. |
116 | 146 |
|
117 | | -• **client** |
| 147 | +##### client |
118 | 148 |
|
119 | 149 | The client to use. |
120 | 150 |
|
121 | | -• **client.client\_name**: `string` |
| 151 | +###### client_name |
122 | 152 |
|
123 | | -• **client.client\_version**: `string` |
| 153 | +`string` |
124 | 154 |
|
125 | | -• **params** |
| 155 | +###### client_version |
| 156 | + |
| 157 | +`string` |
| 158 | + |
| 159 | +##### params |
126 | 160 |
|
127 | 161 | Call parameters. |
128 | 162 |
|
129 | 163 | #### Returns |
130 | 164 |
|
131 | 165 | `Promise`\<`Response`\> |
132 | | - |
133 | | -#### Defined in |
134 | | - |
135 | | -[src/core/Actions.ts:59](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/core/Actions.ts#L59) |
|
0 commit comments