Class Params

Hierarchy

Params

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Params(): Rest.Params

- Defined in @types/Gjs/Rest-1.0.d.ts:1426
Create a new #RestParams.

Returns Rest.Params

Properties

Static name

name: string

Methods

add

add(param: Rest.Param): void

- Defined in @types/Gjs/Rest-1.0.d.ts:1375
Add param to params.

Parameters
- param: Rest.Param
  
  a valid #RestParam
Returns void

are_strings

are_strings(): boolean

- Defined in @types/Gjs/Rest-1.0.d.ts:1380
Checks if the parameters are all simple strings (have a content type of "text/plain").

Returns boolean

as_string_hash_table

as_string_hash_table(): HashTable<string | number | symbol, string | number | boolean>

- Defined in @types/Gjs/Rest-1.0.d.ts:1388
Create a new #GHashTable which contains the name and value of all string (content type of text/plain) parameters.

The values are owned by the #RestParams, so don't destroy the #RestParams before the hash table.

Returns HashTable<string | number | symbol, string | number | boolean>

copy

copy(): Rest.Params

- Defined in @types/Gjs/Rest-1.0.d.ts:1392
Makes a deep copy of a #RestParams.

Returns Rest.Params

get

get(name: string): Rest.Param

- Defined in @types/Gjs/Rest-1.0.d.ts:1397
Return the #RestParam called name, or %NULL if it doesn't exist.

Parameters
- name: string
  
  a parameter name
Returns Rest.Param

ref

ref(): Rest.Params

- Defined in @types/Gjs/Rest-1.0.d.ts:1401
Increments the reference count of self by one.

Returns Rest.Params

remove

remove(name: string): void

- Defined in @types/Gjs/Rest-1.0.d.ts:1406
Remove the #RestParam called name.

Parameters
- name: string
  
  a parameter name
Returns void

unref

unref(): void

- Defined in @types/Gjs/Rest-1.0.d.ts:1411
Decrements the reference count of self by one, freeing the structure when the reference count reaches zero.

Returns void

Static new

new(): Rest.Params

- Defined in @types/Gjs/Rest-1.0.d.ts:1431
Create a new #RestParams.

Returns Rest.Params