Class

com.amarjanica.discourse

DiscourseApiClient

Related Doc: package discourse

Permalink

class DiscourseApiClient extends StrictLogging with WithApiKey with WithBadges with WithCategories with WithNotifications with WithPosts with WithSearch with WithTopics with WithUsers

Client for discourse forum api requests

Linear Supertypes
WithUsers, WithTopics, WithSearch, WithPosts, WithNotifications, WithCategories, WithBadges, WithApiKey, StrictLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DiscourseApiClient
  2. WithUsers
  3. WithTopics
  4. WithSearch
  5. WithPosts
  6. WithNotifications
  7. WithCategories
  8. WithBadges
  9. WithApiKey
  10. StrictLogging
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DiscourseApiClient(endPoint: String, credentials: Option[Credentials] = None, httpClient: BaseHttpClient = ...)

    Permalink

    endPoint

    discourse site url e.g. http://discourse.mysite.com

    credentials

    api_username and api_key

Type Members

  1. implicit class RichString extends AnyRef

    Permalink
    Attributes
    protected

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to any2stringadd[DiscourseApiClient] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (DiscourseApiClient, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to ArrowAssoc[DiscourseApiClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def createBadge(createBadge: CreateBadge): Badge

    Permalink
    Definition Classes
    WithBadges

  9. def createCategory(createCategory: CreateCategory): Category

    Permalink
    Definition Classes
    WithCategories

  10. def createPost(createPost: CreatePost): Post

    Permalink
    Definition Classes
    WithPosts

  11. def createTopic(createPost: CreatePost): Topic

    Permalink
    Definition Classes
    WithTopics

  12. def createUser(createUserRequest: CreateUser): CreateUserResponse

    Permalink
    Definition Classes
    WithUsers

  13. val credentials: Option[Credentials]

    Permalink

    api_username and api_key

  14. def delete(uri: String): Boolean

    Permalink
    Attributes
    protected

  15. def deletePost(id: Int): Unit

    Permalink
    Definition Classes
    WithPosts

  16. def editPost(id: Int, createPost: CreatePost): Post

    Permalink
    Definition Classes
    WithPosts

  17. def ensuring(cond: (DiscourseApiClient) ⇒ Boolean, msg: ⇒ Any): DiscourseApiClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to Ensuring[DiscourseApiClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: (DiscourseApiClient) ⇒ Boolean): DiscourseApiClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to Ensuring[DiscourseApiClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean, msg: ⇒ Any): DiscourseApiClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to Ensuring[DiscourseApiClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: Boolean): DiscourseApiClient

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to Ensuring[DiscourseApiClient] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  23. def finalize(): Unit

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

  24. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to StringFormat[DiscourseApiClient] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  25. def generateApiKey(userId: Int): ApiKey

    Permalink
    Definition Classes
    WithApiKey

  26. def get[T](uri: String, opts: Map[String, String]): String

    Permalink
    Attributes
    protected

  27. def get(uri: String): String

    Permalink
    Attributes
    protected

  28. def getCategory(id: Int): Category

    Permalink
    Definition Classes
    WithCategories

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

    Permalink
    Definition Classes
    AnyRef → Any

  30. def getPost(id: Int, args: Map[String, String] = Map.empty): Post

    Permalink
    Definition Classes
    WithPosts

  31. def getTopic(id: Int): Topic

    Permalink
    Definition Classes
    WithTopics

  32. def getUser(username: String): UserDetail

    Permalink
    Definition Classes
    WithUsers

  33. def grantUserBadge(grantBadge: GrantBadge): Badge

    Permalink
    Definition Classes
    WithBadges

  34. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  36. def listApiKeys(): Array[ApiKey]

    Permalink
    Definition Classes
    WithApiKey

  37. def listBadges(): Array[Badge]

    Permalink
    Definition Classes
    WithBadges

  38. def listCategories(opts: Map[String, String]): Array[Category]

    Permalink
    Definition Classes
    WithCategories

  39. def listLatestTopics(categorySlugOrId: String): Array[Topic]

    Permalink
    Definition Classes
    WithTopics

  40. def listNewTopics(categorySlugOrId: String): Array[Topic]

    Permalink
    Definition Classes
    WithTopics

  41. def listNotifications(): NotificationResponse

    Permalink
    Definition Classes
    WithNotifications

  42. def listTopTopics(categorySlugOrId: String): Array[Topic]

    Permalink
    Definition Classes
    WithTopics

  43. def listUserBadges(username: String): Array[Badge]

    Permalink
    Definition Classes
    WithBadges

  44. def listUsers(kind: String): Array[User]

    Permalink
    Definition Classes
    WithUsers

  45. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    StrictLogging

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

    Permalink
    Definition Classes
    AnyRef

  47. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  48. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  49. def post[T <: SerializableAsJson](uri: String): String

    Permalink
    Attributes
    protected

  50. def post[T <: SerializableAsJson](uri: String, data: T): String

    Permalink
    Attributes
    protected

  51. def put(uri: String): String

    Permalink
    Attributes
    protected

  52. def put[T <: SerializableAsJson](uri: String, opts: Map[String, String], data: T): String

    Permalink
    Attributes
    protected

  53. def put[T <: SerializableAsJson](uri: String, data: T): String

    Permalink
    Attributes
    protected

  54. def requestBuilder(): Builder

    Permalink
    Attributes
    protected

  55. def revokeUserApiKey(userId: Int): Boolean

    Permalink
    Definition Classes
    WithApiKey

  56. def searchQuery(term: String, opts: Map[String, String]): SearchResponse

    Permalink

    Returns search results that match the specified term.

    Returns search results that match the specified term.

    term

    search term

    opts

    optional query parameters e.g type_filter, include_blurbs, blurb_length

    Definition Classes
    WithSearch

  57. def searchQuery(term: String): SearchResponse

    Permalink
    Definition Classes
    WithSearch

  58. def suspendUser(userId: Int, suspendUser: SuspendUser): Unit

    Permalink
    Definition Classes
    WithUsers

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

    Permalink
    Definition Classes
    AnyRef

  60. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  61. def unsuspendUser(userId: Int, level: Int): Unit

    Permalink
    Definition Classes
    WithUsers

  62. def updateCategory(category: Category): Category

    Permalink
    Definition Classes
    WithCategories

  63. def updateEmail(username: String, email: String): Unit

    Permalink
    Definition Classes
    WithUsers

  64. def updateTrustLevel(userId: Int, level: Int): Unit

    Permalink
    Definition Classes
    WithUsers

  65. def updateUser(user: User): UpdateUserStatus

    Permalink
    Definition Classes
    WithUsers

  66. def updateUsername(currentUsername: String, newUsername: String): Unit

    Permalink
    Definition Classes
    WithUsers

  67. final def wait(): Unit

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

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

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

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

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

  70. def →[B](y: B): (DiscourseApiClient, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DiscourseApiClient to ArrowAssoc[DiscourseApiClient] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from WithUsers

Inherited from WithTopics

Inherited from WithSearch

Inherited from WithPosts

Inherited from WithNotifications

Inherited from WithCategories

Inherited from WithBadges

Inherited from WithApiKey

Inherited from StrictLogging

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DiscourseApiClient to any2stringadd[DiscourseApiClient]

Inherited by implicit conversion StringFormat from DiscourseApiClient to StringFormat[DiscourseApiClient]

Inherited by implicit conversion Ensuring from DiscourseApiClient to Ensuring[DiscourseApiClient]

Inherited by implicit conversion ArrowAssoc from DiscourseApiClient to ArrowAssoc[DiscourseApiClient]

Ungrouped