Method: Appwrite::Messaging#list_providers

Defined in:
lib/appwrite/services/messaging.rb

#list_providers(queries: nil, search: nil) ⇒ ProviderList

Get a list of all providers from the current Appwrite project.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

Returns:

  • (ProviderList) 


506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/appwrite/services/messaging.rb', line 506

def list_providers(queries: nil, search: nil)
    api_path = '/messaging/providers'

    api_params = {
        queries: queries,
        search: search,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ProviderList
    )
end