mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-09 12:47:44 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1
This commit is contained in:
92
docs/sdks/activities/README.md
Normal file
92
docs/sdks/activities/README.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Activities
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints.
|
||||
Activities are associated with HTTP replies via a special `X-Plex-Activity` header which contains the UUID of the activity.
|
||||
Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details:
|
||||
- They can contain a `progress` (from 0 to 100) marking the percent completion of the activity.
|
||||
- They must contain an `type` which is used by clients to distinguish the specific activity.
|
||||
- They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.)
|
||||
- The may contain a `Response` object which attributes which represent the result of the asynchronous operation.
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [get_server_activities](#get_server_activities) - Get Server Activities
|
||||
* [cancel_server_activities](#cancel_server_activities) - Cancel Server Activities
|
||||
|
||||
## get_server_activities
|
||||
|
||||
Get Server Activities
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require_relative plexruby
|
||||
|
||||
|
||||
s = OpenApiSDK::PlexAPI.new
|
||||
s.config_security(
|
||||
security=Shared::Security.new(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
res = s.activities.get_server_activities()
|
||||
|
||||
if ! res.two_hundred_application_json_object.nil?
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(Operations::GetServerActivitiesResponse)](../../models/operations/getserveractivitiesresponse.md)**
|
||||
|
||||
|
||||
## cancel_server_activities
|
||||
|
||||
Cancel Server Activities
|
||||
|
||||
### Example Usage
|
||||
|
||||
```ruby
|
||||
require_relative plexruby
|
||||
|
||||
|
||||
s = OpenApiSDK::PlexAPI.new
|
||||
s.config_security(
|
||||
security=Shared::Security.new(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
req = Operations::CancelServerActivitiesRequest.new(
|
||||
activity_uuid="string",
|
||||
)
|
||||
|
||||
res = s.activities.cancel_server_activities(activity_uuid="string")
|
||||
|
||||
if res.status == 200
|
||||
# handle response
|
||||
end
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `activity_uuid` | *String* | :heavy_check_mark: | The UUID of the activity to cancel. |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[T.nilable(Operations::CancelServerActivitiesResponse)](../../models/operations/cancelserveractivitiesresponse.md)**
|
||||
|
||||
Reference in New Issue
Block a user