# plugins package

## Submodules

## plugins.Camera module

class `plugins.Camera.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `SLUG` = 'camera'
  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

## plugins.CleanCache module

class `plugins.CleanCache.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `SLUG` = 'cleancache'
  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

## plugins.Echo module

class `plugins.Echo.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

## plugins.Email module

class `plugins.Email.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `SLUG` = 'email'
  `fetchUnreadEmails`(since=None, markRead=False, limit=None)

    Fetches a list of unread email objects from a user’s email inbox.

    Arguments: since – if provided, no emails before this date will be returned markRead – if True, marks all returned emails as read in target inbox

    Returns: A list of unread email objects.

  `getDate`(email)
  `getMostRecentDate`(emails)

    Returns the most recent date of any email in the list provided.

    Arguments: emails – a list of emails to check

    Returns: Date of the most recent email.

  `getSender`(msg)

    Returns the best-guess sender of an email.

    Arguments: msg – the email whose sender is desired

    Returns: Sender of the sender.

  `getSubject`(msg)

    Returns the title of an email

    Arguments: msg – the email

    Returns: Title of the email.

  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isNewEmail`()

    Wether an email is a new email

  `isSelfEmail`(msg)

    Whether the email is sent by the user

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

## plugins.Geek module

class `plugins.Geek.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `IS_IMMERSIVE` = True
  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

  `isValidImmersive`(text, parsed)

    是否适合在沉浸模式下处理， 仅适用于有沉浸模式的插件（如音乐等） 当用户唤醒时，可以响应更多指令集。 例如：“”上一首”、”下一首” 等

  `onAsk`(input)
  `restore`()

    恢复当前插件， 仅适用于有沉浸模式的插件（如音乐等） 当用户误唤醒或者唤醒进行闲聊后， 可以自动恢复当前插件的处理逻辑

## plugins.LocalPlayer module

class `plugins.LocalPlayer.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `IS_IMMERSIVE` = True
  `get_song_list`(path)
  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `init_music_player`()
  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

  `isValidImmersive`(text, parsed)

    是否适合在沉浸模式下处理， 仅适用于有沉浸模式的插件（如音乐等） 当用户唤醒时，可以响应更多指令集。 例如：“”上一首”、”下一首” 等

  `pause`()

    暂停当前正在处理的任务， 当处于该沉浸模式下且被唤醒时， 将自动触发这个方法， 可以用于强制暂停一个耗时的操作

  `restore`()

    恢复当前插件， 仅适用于有沉浸模式的插件（如音乐等） 当用户误唤醒或者唤醒进行闲聊后， 可以自动恢复当前插件的处理逻辑

## plugins.Poem module

class `plugins.Poem.``Plugin`(con)

  基类：`robot.sdk.AbstractPlugin.AbstractPlugin`

  `SLUG` = 'poem'
  `handle`(text, parsed)

    处理逻辑

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

  `isValid`(text, parsed)

    是否适合由该插件处理

    参数： query – 用户的指令字符串 parsed – 用户指令经过 NLU 解析后的结果

    返回： True: 适合由该插件处理 False: 不适合由该插件处理

## Module contents