package
0.16.1
Repository: https://github.com/lukehagar/plexgo.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
WithOperationTimeout allows setting the request timeout applied for an operation.
WithRetries allows customizing the default retry configuration.
WithServerURL allows providing an alternative server URL.
WithTemplatedServerURL allows providing an alternative server URL with templated parameters.
WithURLOverride allows overriding the URL.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AddPlaylistContentsResponseBody - Playlist Updated.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CreatePlaylistResponseBody - returns all playlists.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GeoData - Geo location data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetAllLibrariesResponseBody - The libraries available on the Server.
No description provided by the author
No description provided by the author
GetAvailableClientsResponseBody - Available Clients.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetBandwidthStatisticsResponseBody - Bandwidth Statistics.
No description provided by the author
No description provided by the author
No description provided by the author
GetButlerTasksResponseBody - All butler tasks.
No description provided by the author
No description provided by the author
No description provided by the author
GetDevicesResponseBody - Devices.
No description provided by the author
No description provided by the author
GetGeoDataGeoData - Geo location data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetGlobalHubsResponseBody - returns global hubs.
No description provided by the author
GetHomeDataResponseBody - Home Data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetLibraryDetailsResponseBody - The details of the library.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetLibraryHubsResponseBody - The hubs specific to the library.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetLibraryItemsMediaContainer - The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
No description provided by the author
GetLibraryItemsMeta - The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetLibraryItemsResponseBody - The contents of the library by section and tag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetMediaProvidersResponseBody - Media providers and their features.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetMetaDataByRatingKeyResponseBody - The metadata of the library item.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetMetadataChildrenResponseBody - The children of the library item.
No description provided by the author
GetMyPlexAccountResponseBody - MyPlex Account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetOnDeckResponseBody - The on Deck content.
No description provided by the author
GetPinAuthPinContainer - Requests a new pin id used in the authentication flow.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetPlaylistContentsResponseBody - The playlist contents.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetPlaylistResponseBody - The playlist.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetPlaylistsResponseBody - returns all playlists.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetRecentlyAddedLibraryMediaContainer - The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetRecentlyAddedLibraryResponseBody - The recently added content.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetRecentlyAddedResponseBody - A successful response with recently added content.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetResourcesStatisticsResponseBody - Resource Statistics.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSearchAllLibrariesResponseBody - The libraries available on the Server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSearchLibraryResponseBody - The contents of the library by section and type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSearchResultsResponseBody - Search Results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetServerActivitiesResponseBody - The Server Activities.
No description provided by the author
GetServerCapabilitiesResponseBody - The Server Capabilities.
No description provided by the author
No description provided by the author
GetServerIdentityResponseBody - The Server Identity information.
No description provided by the author
No description provided by the author
GetServerListResponseBody - List of Servers.
No description provided by the author
No description provided by the author
No description provided by the author
GetServerPreferencesResponseBody - Server Preferences.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSessionHistoryResponseBody - List of Plex Sessions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSessionsResponseBody - List of Active Plex Sessions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetStatisticsResponseBody - Media Statistics.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetTokenByPinIDAuthPinContainer - The Pin with a non-null authToken when it has been verified by the user.
GetTokenByPinIDGeoData - Geo location data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetTokenDetailsUserPlexAccount - Logged in user details.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetTopWatchedContentResponseBody - The metadata of the library item.
No description provided by the author
No description provided by the author
No description provided by the author
GetTranscodeSessionsResponseBody - The Transcode Sessions.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetUpdateStatusResponseBody - The Server Updates.
No description provided by the author
No description provided by the author
No description provided by the author
GetWatchListResponseBody - Watchlist Data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PostUsersSignInDataRequestBody - Login credentials.
No description provided by the author
No description provided by the author
PostUsersSignInDataSubscription - If the account’s Plex Pass subscription is active.
PostUsersSignInDataUserPlexAccount - Returns the user account data with a valid auth token.
No description provided by the author
No description provided by the author
No description provided by the author
QueryParamFilter - Filters content by field and direction/equality (Unknown if viewedAt is the only supported column).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Subscription - If the account’s Plex Pass subscription is active.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
ActiveDirection - The direction of the sort.
AutoSelectSubtitle - The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled).
CreatePlaylistQueryParamType - type of playlist to create.
DefaultDirection - The direction of the sort.
DefaultSubtitleAccessibility - The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles).
DefaultSubtitleForced - The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles).
Download - Indicate that you want to start download any updates found.
Filter.
No description provided by the author
Force the refresh even if the library is already being refreshed.
GetLibraryItemsActiveDirection - The direction of the sort.
GetLibraryItemsDefaultDirection - The direction of the sort.
No description provided by the author
No description provided by the author
GetLibraryItemsLibraryActiveDirection - The direction of the sort.
GetLibraryItemsLibraryDefaultDirection - The direction of the sort.
No description provided by the author
GetLibraryItemsLibraryType - The type of media content.
No description provided by the author
GetLibraryItemsQueryParamIncludeMeta - Adds the Meta object to the response.
GetLibraryItemsQueryParamType - The type of media to retrieve.
GetLibraryItemsShowOrdering - Setting that indicates the episode ordering for the show None = Library default, tmdbAiring = The Movie Database (Aired), aired = TheTVDB (Aired), dvd = TheTVDB (DVD), absolute = TheTVDB (Absolute)).
GetPlaylistContentsQueryParamType - The type of media to retrieve.
GetRecentlyAddedActiveDirection - The direction of the sort.
GetRecentlyAddedDefaultDirection - The direction of the sort.
No description provided by the author
GetRecentlyAddedHubsType - The type of media content.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSearchAllLibrariesShowOrdering - Setting that indicates the episode ordering for the show None = Library default, tmdbAiring = The Movie Database (Aired), aired = TheTVDB (Aired), dvd = TheTVDB (DVD), absolute = TheTVDB (Absolute)).
GetSearchAllLibrariesType - The type of media content.
GetSearchLibraryQueryParamType - The type of media to retrieve.
GetTokenDetailsAuthenticationResponseStatus - String representation of subscriptionActive.
GetTokenDetailsAuthenticationStatus - String representation of subscriptionActive.
No description provided by the author
GetTopWatchedContentQueryParamType - The type of media to retrieve.
GetTransientTokenQueryParamType - `delegation` - This is the only supported `type` parameter.
No description provided by the author
IncludeCollections - include collections in the results.
IncludeDetails - Whether or not to include details for a section (types, filters, and sorts).
IncludeExternalMedia - include external media in the results.
IncludeGuids - Adds the Guids object to the response.
IncludeHTTPS - Include Https entries in the results.
IncludeIPv6 - Include IPv6 entries in the results.
IncludeMeta - Adds the Meta object to the response.
IncludeRelay - Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400.
Level - An integer log level to write to the PMS log with.
Libtype - The type of library to filter.
MailingListStatus - Your current mailing list status (active or unsubscribed).
MediaReviewsVisibility - Whether or not the account has media reviews visibility enabled.
MinSize - images are always scaled proportionally.
OnlyTransient - Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g.
No description provided by the author
No description provided by the author
PathParamTaskName - The name of the task to be started.
PlaylistType - limit to a type of playlist.
PostUsersSignInDataAuthenticationResponseStatus - String representation of subscriptionActive.
PostUsersSignInDataAuthenticationStatus - String representation of subscriptionActive.
PostUsersSignInDataAutoSelectSubtitle - The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled).
PostUsersSignInDataDefaultSubtitleAccessibility - The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles).
PostUsersSignInDataDefaultSubtitleForced - The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles).
PostUsersSignInDataMailingListStatus - Your current mailing list status (active or unsubscribed).
PostUsersSignInDataMediaReviewsVisibility - Whether or not the account has media reviews visibility enabled.
No description provided by the author
No description provided by the author
PostUsersSignInDataWatchedIndicator - Whether or not media watched indicators are enabled (little orange dot on media).
Protocol - The protocol used for the connection (http, https, etc).
QueryParamForce - Force overwriting of duplicate playlists.
QueryParamIncludeCollections - Whether to include collections in the search results.
QueryParamIncludeExternalMedia - Whether to include external media in the search results.
QueryParamIncludeMeta - Adds the Meta object to the response.
QueryParamOnlyTransient - Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g.
QueryParamSmart - type of playlists to return (default is all).
QueryParamType - The type of media to retrieve.
Scope - `all` - This is the only supported `scope` parameter.
No description provided by the author
ShowOrdering - Setting that indicates the episode ordering for the show None = Library default, tmdbAiring = The Movie Database (Aired), aired = TheTVDB (Aired), dvd = TheTVDB (DVD), absolute = TheTVDB (Absolute)).
Skip - Indicate that the latest version should be marked as skipped.
Smart - whether the playlist is smart or not.
State - The state of the media item.
Status - Current friend request status.
Tag - A key representing a specific tag within the section.
TaskName - the name of the task to be started.
Tonight - Indicate that you want the update to run during the next Butler execution.
Type - The type of media to retrieve.
Upscale - allow images to be resized beyond native dimensions.
WatchedIndicator - Whether or not media watched indicators are enabled (little orange dot on media).