communications

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2022 License: MIT Imports: 6 Imported by: 0

README

GoCryptoTrader package Comms

Build Status Software License GoDoc Coverage Status Go Report Card

This comms package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Communications package

What is the Communications package?
  • This package allows for the communication of events/data that occurs in the to be exported out to a defined communication medium
Current Features
  • Slack bot support
  • SMSGlobal instant bulk messaging
  • SMTP messaging
  • Telegram bot support
How to enable example
  • In your config.json enable each individual communications package you desire
  • Please view the individual readme documentation inside the specific package for more details
Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrNoRelayersEnabled = errors.New("no communication relayers are enabled")

ErrNoRelayersEnabled returns when no communication relayers are enabled

Functions

This section is empty.

Types

type Communications

type Communications struct {
	base.IComm
}

Communications is the overarching type across the communications packages

func NewComm

NewComm sets up and returns a pointer to a Communications object

Directories

Path Synopsis
Package slack is used to connect to the slack network.
Package slack is used to connect to the slack network.
Package smsglobal allows bulk messaging to a desired recipient list
Package smsglobal allows bulk messaging to a desired recipient list
Package telegram is used to connect to a cloud-based mobile and desktop messaging app using the bot API defined in https://core.telegram.org/bots/api#recent-changes
Package telegram is used to connect to a cloud-based mobile and desktop messaging app using the bot API defined in https://core.telegram.org/bots/api#recent-changes

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL