giphy

Documentation

Overview

Package giphy implements a Service which adds !commands for Giphy.

Index

• Constants
• type Service
  • func (s *Service) Commands(client types.MatrixClient) []types.Command

Constants

const ServiceType = "giphy"

ServiceType of the Giphy service.

Types

type Service

type Service struct {
	types.DefaultService
	// The Giphy API key to use when making HTTP requests to Giphy.
	// The public beta API key is "dc6zaTOxFJmzC".
	APIKey string `json:"api_key"`
	// Whether to use the downsized image from Giphy.
	// Uses the original image when set to false.
	// Defaults to false.
	UseDownsized bool `json:"use_downsized"`
}

Service contains the Config fields for the Giphy Service.

Example request:

{
    "api_key": "dc6zaTOxFJmzC",
    "use_downsized": false
}

func (*Service) Commands

func (s *Service) Commands(client types.MatrixClient) []types.Command

Commands supported:

!giphy some search query without quotes

Responds with a suitable GIF into the same room as the command.