Packages

object SlackApiClient

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SlackApiClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class SlackApiClientBuildOptions[F[_]] extends Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def build[F[_]](sttpBackend: SttpBackendType[F])(implicit arg0: BackendType[F]): SlackApiClientBuildOptions[F]

    Build an instance of Slack API client with the specified backend and options

    Build an instance of Slack API client with the specified backend and options

    F

    scala.concurrent.Future or cats.effect.IO

    sttpBackend

    an STTP backend

    returns

    an instance builder

  6. def build[F[_]](implicit arg0: BackendType[F], sttpBackend: SttpBackendType[F]): SlackApiClientBuildOptions[F]

    Build an instance of Slack API client with the specified options

    Build an instance of Slack API client with the specified options

    For example:

    SlackApiClient
     .build(AsyncHttpClientFutureBackend())
     .withThrottler( SlackApiRateThrottler.createStandardThrottler() )
     .create()
    F

    scala.concurrent.Future or cats.effect.IO

    sttpBackend

    an implicitly defined STTP backend

    returns

    an instance builder

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def create[F[_]]()(implicit arg0: BackendType[F], sttpBackend: SttpBackendType[F]): SlackApiClientT[F]

    Create an instance of Slack API client for the specified backend kind (Future|cats-effect IO, etc)

    Create an instance of Slack API client for the specified backend kind (Future|cats-effect IO, etc)

    F

    scala.concurrent.Future or cats.effect.IO

    sttpBackend

    an implicitly defined STTP backend

    returns

    an instance of Slack API client For example:

    // For Future:
    implicit val sttpBackend = AsyncHttpClientFutureBackend()
    
    SlackApiClient.create()

    An example for cats-effect IO:

    implicit val cs: ContextShift[IO] = IO.contextShift( scala.concurrent.ExecutionContext.global )
    
    AsyncHttpClientCatsBackend[IO]()
          .flatMap { implicit backEnd =>
            for {
              client <- IO( SlackApiClient.create[IO]() )
              testResult <- client.api.test( SlackApiTestRequest() )
            }
            yield
               testResult
          }
    
    SlackApiClient.create()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toResource[F[_]](client: SlackApiClientT[F])(implicit arg0: BackendType[F]): Resource[F, SlackApiClientT[F]]

    Wrap a client instance into cats Resource

    Wrap a client instance into cats Resource

    F

    scala.concurrent.Future or cats.effect.IO

    client

    a client instance

    returns

    a resource

  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped