Class KodiProfilesNamespace

Index

Constructors

Methods

GetCurrentProfile GetProfiles LoadProfile

Constructors

constructor

new KodiProfilesNamespace(sendMessage: ISendMessage): KodiProfilesNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiProfilesNamespace
- Defined in namespaces/profiles.ts:24

Methods

GetCurrentProfile

GetCurrentProfile(): Promise<ProfileDetails>
Retrieves the current active profile.

Returns Promise<ProfileDetails>
A promise resolving to the details of the current profile.
- Defined in namespaces/profiles.ts:33

GetProfiles

GetProfiles(
    properties?: string[],
    limits?: ListLimits,
    sort?: ListSort,
): Promise<ProfilesGetProfilesResponse>
Retrieves all available profiles with optional filtering and pagination.
Parameters
- Optionalproperties: string[]
  Optional list of properties to retrieve for each profile.
- Optionallimits: ListLimits
  Optional pagination limits.
- Optionalsort: ListSort
  Optional sorting options.
Returns Promise<ProfilesGetProfilesResponse>
A promise resolving to a list of profiles and pagination details.
- Defined in namespaces/profiles.ts:45

LoadProfile

LoadProfile(
    profile: string,
    prompt?: boolean,
    password?: string,
): Promise<ProfilesLoadProfileResponse>
Loads the specified profile, optionally prompting for a password.
Parameters
- profile: string
  The name of the profile to load.
- prompt: boolean = false
  Whether to prompt for a password if required.
- password: string = ""
  The password for the profile, if applicable.
Returns Promise<ProfilesLoadProfileResponse>
A promise resolving to a boolean indicating success.
- Defined in namespaces/profiles.ts:62