Trait

ru.pavkin.todoist.api.core

ExecutedAuthorizedAPI

Related Doc: package core

Permalink

trait ExecutedAuthorizedAPI[F[_], L[_], P[_], Req, Base] extends AuthorizedAPI[F, P, Base] with ExecutedAPI[F, L, P, Req, Base]

Linear Supertypes
ExecutedAPI[F, L, P, Req, Base], AuthorizedAPI[F, P, Base], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExecutedAuthorizedAPI
  2. ExecutedAPI
  3. AuthorizedAPI
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def F: Functor[L]

    Permalink
    Definition Classes
    ExecutedAPI

  2. abstract def executor: Aux[Req, L, Base]

    Permalink
    Definition Classes
    ExecutedAPI

  3. abstract def flattener: Flattener[F, L, P]

    Permalink
    Definition Classes
    ExecutedAPI

  4. abstract def requestFactory: Produce[RawRequest, Req]

    Permalink
    Definition Classes
    ExecutedAPI

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. def get[R](implicit IR: HasRawRequest[R], parser: SingleResponseDecoder[P, Base, R]): SingleQueryDefinition[F, P, R, Base]

    Permalink

    Returns a single resource request definition, that after being executed will return the resource of type R

    Returns a single resource request definition, that after being executed will return the resource of type R

    Definition Classes
    ExecutedAuthorizedAPI → AuthorizedAPI

  10. def getAll[R <: HList](implicit IR: HasRawRequest[R], ID: IsDistinctConstraint[R], parser: MultipleResponseDecoder[P, Base, R]): MultipleQueryDefinition[F, P, R, Base]

    Permalink

    Returns a multiple resources request definition, that after being executed will return an HList of resources, specified in phantom type parameter R

    Returns a multiple resources request definition, that after being executed will return an HList of resources, specified in phantom type parameter R

    Example usage:

    api.getAll[Projects :: Labels :: Tasks :: HNil]
// will return List[Projects] :: List[Labels] :: List[Tasks] :: HNil upon execution

    Syntax helpers are available for working with multiple resources response. After handling the API effect, you can call these methods on the result:

    res.projects // returns List[Project]
res.labels // returns List[Label]
// ...
// etc, but only for resources that were requested

    For syntax helpers to be available, you should import the syntax toolkit, for example:

    import ru.pavkin.todoist.api.dispatch.circe.default.syntax._
    Definition Classes
    ExecutedAuthorizedAPI → AuthorizedAPI
    Note

    Doesn't allow to specify duplicate resources.

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. def perform[C, R](command: C)(implicit trr: ToRawRequest[C], cr: Aux[C, R], parser: Aux[P, C, Base, R]): SingleCommandDefinition[F, P, C, R, Base]

    Permalink

    Returns a single command request definition, that when being executed performs a supplied command: C and returns command result of type R.

    Returns a single command request definition, that when being executed performs a supplied command: C and returns command result of type R.

    All command results are successors of ru.pavkin.todoist.api.core.model.TodoistCommandResult:

    - For ru.pavkin.todoist.api.core.model.SimpleCommand returns ru.pavkin.todoist.api.core.model.CommandResult - For ru.pavkin.todoist.api.core.model.TempIdCommand returns ru.pavkin.todoist.api.core.model.TempIdCommandResult

    command

    Command to execute within the request

    Definition Classes
    ExecutedAuthorizedAPI → AuthorizedAPI

  18. def performAll[C <: HList, R <: HList, CR <: HList](commands: C)(implicit R: Aux[C, CR], trr: ToRawRequest[CR], cr: Aux[CR, R], parser: Aux[P, CR, Base, R]): MultipleCommandDefinition[F, P, CR, R, Base]

    Permalink

    Returns a multiple commands request definition, that when being executed performs all supplied commands and returns an HList of corresponding command results.

    Returns a multiple commands request definition, that when being executed performs all supplied commands and returns an HList of corresponding command results. See AuthorizedAPI.perform method docs for command results details

    Syntax helpers are available for multiple command results response. After handling the API effect, you can call these methods on the result:

    res.resultFor(_0) // returns strictly typed result of the first command on the list
res.resultFor(_1) // returns strictly typed result of the seconds command on the list
// ...
// and so on, but only for the amount of commands that was actually sent

res.resultFor(uuid:UUID) // tries to find result for command with specific uuid
// returns an Option[TodoistCommandResult]

    For syntax helpers to be available, you should import the syntax toolkit, for example:

    import ru.pavkin.todoist.api.dispatch.circe.default.syntax._
    commands

    HList of commands to execute

    Definition Classes
    ExecutedAuthorizedAPI → AuthorizedAPI

  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExecutedAPI[F, L, P, Req, Base]

Inherited from AuthorizedAPI[F, P, Base]

Inherited from AnyRef

Inherited from Any

Ungrouped