Module: baserequest

Methods

---

<static> APIRequest(url [, params])

Parameters:

Name	Type	Argument	Default	Description
url	string
params	object	<optional>	{}

Source:

• source/api/baserequest.bs, line 26

Returns:

Type

dynamic

---

<static> authRequest(req)

Takes and returns a roUrlTransfer object after adding a Jellyfin "Authorization" header

Parameters:

Name	Type	Description
req	object

Source:

• source/api/baserequest.bs, line 107

Returns:

Type

object

---

<static> buildAuthHeader()

Returns a string containing the "Authorization" header payload

Source:

• source/api/baserequest.bs, line 114

Returns:

Type

string

---

<static> buildParams( [params])

Functions for making requests to the API

Parameters:

Name	Type	Argument	Default	Description
params	object	<optional>	{}

Source:

• source/api/baserequest.bs, line 10

Returns:

Type

string

---

<static> buildURL(path [, params])

Parameters:

Name	Type	Argument	Default	Description
path	string
params	object	<optional>	{}

Source:

• source/api/baserequest.bs, line 18

Returns:

Type

dynamic

---

<static> deleteVoid(req)

Parameters:

Name	Type	Description
req	dynamic

Source:

• source/api/baserequest.bs, line 70

Returns:

Type

dynamic

---

<static> getJson(req)

Parameters:

Name	Type	Description
req	dynamic

Source:

• source/api/baserequest.bs, line 33

Returns:

Type

dynamic

---

<static> getString(req)

Parameters:

Name	Type	Description
req	dynamic

Source:

• source/api/baserequest.bs, line 83

Returns:

Type

dynamic

---

<static> getVoid(req)

Parameters:

Name	Type	Description
req	dynamic

Source:

• source/api/baserequest.bs, line 55

Returns:

Type

boolean

---

<static> get_url()

Source:

• source/api/baserequest.bs, line 76

Returns:

Type

dynamic

---

<static> headVoid(req)

Parameters:

Name	Type	Description
req	dynamic

Source:

• source/api/baserequest.bs, line 48

Returns:

Type

boolean

---

<static> postJson(req [, data])

Parameters:

Name	Type	Argument	Default	Description
req	dynamic
data	string	<optional>	""

Source:

• source/api/baserequest.bs, line 63

Returns:

Type

dynamic

---

<static> postString(req [, data])

Parameters:

Name	Type	Argument	Default	Description
req	dynamic
data	string	<optional>	""

Source:

• source/api/baserequest.bs, line 91

Returns:

Type

dynamic

---

<static> postVoid(req [, data])

Parameters:

Name	Type	Argument	Default	Description
req	dynamic
data	string	<optional>	""

Source:

• source/api/baserequest.bs, line 41

Returns:

Type

boolean

---

<static> setCertificateAuthority(request)

sets the certificate authority by file path on the passed node

Parameters:

Name	Type	Description
request	object

Source:

• source/api/baserequest.bs, line 99

Returns:

Type

void