Listeners

Retrieving listener objects

class ListenerMixin

This class defines all functions related to BlueConic listeners.

get_listener(listener_id)

Gets the listener with the listener ID and returns it as a BlueConic listeners.

Usage:

>>> import blueconic
>>> bc = blueconic.Client()
>>> bc.get_listener('example-listener-id')
<blueconic.domain.listener.Listener>

get_listeners(start=0, count=10000000)

Gets all listeners and returns them in a generator with all BlueConic listeners.

Parameters

start (int, optional) – The listener to start from. Defaults to 0.
count (int, optional) – The number of listeners to retrieve. Defaults to 10000000.

Returns

Iterator with Listener

Return type

Iterator[Listener]

Usage:

>>> import blueconic
>>> bc = blueconic.Client()
>>> bc.get_listeners()
<generator object Listener.get_listeners>

class Listener

property id

property name