shodan.client.Shodan.Notifier

class documentation

class Notifier: (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method create Get the settings for the specified notifier that a user has configured.
Method edit Get the settings for the specified notifier that a user has configured.
Method get Get the settings for the specified notifier that a user has configured.
Method list_notifiers Returns a list of notifiers that the user has added.
Method list_providers Returns a list of supported notification providers.
Method remove Delete the provided notifier.
Instance Variable parent Undocumented
def __init__(self, parent): (source)

Undocumented

def create(self, provider, args, description=None): (source)

Get the settings for the specified notifier that a user has configured. :param provider: Provider name :type provider: str :param args: Provider arguments :type args: dict :param description: Human-friendly description of the notifier :type description: str :returns: dict -- fields are 'success' and 'id' of the notifier

def edit(self, nid, args): (source)

Get the settings for the specified notifier that a user has configured. :param nid: Notifier ID :type nid: str :param args: Provider arguments :type args: dict :returns: dict -- fields are 'success' and 'id' of the notifier

def get(self, nid): (source)

Get the settings for the specified notifier that a user has configured. :param nid: Notifier ID :type nid: str :returns: dict -- object describing the notifier settings

def list_notifiers(self): (source)

Returns a list of notifiers that the user has added. :returns: A list of notifierse that are available on the account

def list_providers(self): (source)

Returns a list of supported notification providers. :returns: A list of providers where each object describes a provider

def remove(self, nid): (source)

Delete the provided notifier. :param nid: Notifier ID :type nid: str :returns: dict -- 'success' set to True if action succeeded

parent = (source)

Undocumented