models

Type Members

1. case class ApiKey(id: Int, key: String, user: Option[BasicUser]) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

2. case class ApiKeyContainer(apiKey: ApiKey) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

3. case class Badge(id: Int, name: String, description: Option[String], grantCount: Int, allowTitle: Boolean, multipleGrant: Boolean, icon: String, image: Option[String] = None, listable: Boolean, enabled: Boolean, badgeGroupingId: Int, system: Boolean, slug: String, badgeTypeId: Int, longDescription: Option[String] = None) extends SerializableAsJson with Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

4. case class BadgeContainer(badges: Array[Badge]) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

5. class BasicUser extends Serializable with SerializableAsJson

   

   Annotations

   @JsonIgnoreProperties()

6. case class Category(id: Int, name: String, color: String, textColor: String, description: Option[String] = None, permissions: Option[Map[String, Int]] = None, parentCategoryId: Option[Int] = None, slug: Option[String] = None, autoCloseHours: Option[String] = None, autoCloseBasedOnLastPost: Option[Boolean] = None, position: Option[Int] = None, emailIn: Option[Boolean], emailInAllowStrangers: Option[Boolean] = None, logoUrl: Option[String] = None, allowBadges: Option[Boolean] = None, topicTemplate: Option[String] = None) extends SerializableAsJson with Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

7. case class CategoryContainer(category: Category) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

8. case class CategoryList(categories: Array[Category]) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

9. case class CategoryListContainer(category_list: CategoryList) extends Product with Serializable

   

   Annotations

   @JsonIgnoreProperties()

10. case class CreateBadge(name: String, badgeTypeId: Int, description: Option[String] = None, allowTitle: Option[Boolean] = None, multipleGrant: Option[Boolean] = None, icon: Option[String] = None, listable: Option[Boolean] = None, targetPosts: Option[String] = None, query: Option[String] = None, enabled: Option[Boolean] = None, autoRevoke: Option[Boolean] = None, badgeGroupingId: Option[Int] = None, showPosts: Option[Boolean] = None, image: Option[String] = None, longDescription: Option[String] = None) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

11. case class CreateCategory(name: String, color: String, textColor: String, description: Option[String] = None, permissions: Option[Map[String, Int]] = None, parentCategoryId: Option[Int] = None) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

12. case class CreatePost(title: String, raw: String, topicId: Option[Long] = None, archetype: Option[String] = None, category: String, targetUsernames: Option[String] = None, replyToPostNumber: Option[Int] = None, autoTrack: Boolean = true) extends SerializableAsJson with Product with Serializable

    

13. case class CreateUser(name: String, username: String, password: String, active: Boolean, email: String, staged: Boolean = false) extends SerializableAsJson with Product with Serializable

    

14. case class CreateUserResponse(success: Boolean, active: Option[Boolean], message: String, userId: Int) extends Product with Serializable

    

15. case class Credentials(api_username: String, api_key: String) extends HasParameters with HasQueryParameters with Product with Serializable

    

    Used for authorizing discourse requests

    Used for authorizing discourse requests

    api_username

    - same as username you use to login to discourse

    api_key

    - key is listed in /admin/api (very long string). Recommended api_key is not a master api key, but a key generated specifically for your admin username (api_username), located in http://www.rockbazaar.com/forum/admin/users/{id}/{username}, below Permissions title.

16. case class DiscourseApiException(msg: String, err: Throwable) extends Exception with Product with Serializable

    

17. case class DiscourseApiJsonException(msg: String, err: Throwable) extends Exception with Product with Serializable

    

18. case class DiscourseApiNotFoundException(msg: String, err: Throwable) extends Exception with Product with Serializable

    

19. case class DiscourseApiUnauthenticatedException(msg: String, err: Throwable) extends Exception with Product with Serializable

    

20. case class DiscourseStatusMessage(success: Boolean, message: String) extends Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

21. case class GrantBadge(badgeId: Int, username: String, reason: String) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

22. case class Group(id: Int, automatic: Boolean, name: String, userCount: Int, aliasLevel: Int, visible: Boolean, title: Option[String] = None, primaryGroup: Boolean) extends Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

23. case class GroupedSearchResult(morePosts: Option[Boolean] = None, moreUsers: Option[Boolean] = None, moreCategories: Option[Boolean] = None, postIds: Array[Long], userIds: Array[Long], categoryIds: Array[Long]) extends Product with Serializable

    

24. type JsonIgnoreProperties = fasterxml.jackson.annotation.JsonIgnoreProperties

    

25. type JsonProperty = fasterxml.jackson.annotation.JsonProperty

    

26. case class Notification(id: Int, notificationType: Int, read: Boolean, createdAt: OffsetDateTime, postNumber: Option[Int] = None, topicId: Option[Int] = None, slug: Option[String] = None, data: Map[String, String] = Map.empty) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

27. case class NotificationResponse(notifications: Array[Notification], totalRowsNotifications: Int) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

28. case class Post(id: Int, cooked: String, topic_id: Int, updated_at: OffsetDateTime, created_at: OffsetDateTime) extends Product with Serializable

    

29. case class PostStream(posts: Array[Post]) extends Product with Serializable

    

30. case class SSOContext(payload: String, signature: String, secret: String) extends Product with Serializable

    

31. case class SSOUserRequest(email: String, require_activation: Boolean, external_id: String, username: String, name: String, avatar_url: String, admin: Boolean, moderator: Boolean, avatar_force_update: Boolean, suppress_welcome_message: Boolean) extends HasParameters with HasQueryParameters with Product with Serializable

    

    Contains params for generating user signing tokens for Discourse

    Contains params for generating user signing tokens for Discourse

    email

    must be a verified email address.

    require_activation

    true If the email address has not been verified, set require_activation to "true".

    external_id

    Your unique user id. The suggested value is your database's 'id' row number.

    username

    will become the username on Discourse if the user is new or SiteSetting.sso_overrides_username is set.

    name

    will become the full name on Discourse if the user is new or SiteSetting.sso_overrides_name is set.

    admin

    boolean

    moderator

    boolean

    suppress_welcome_message

    boolean

32. case class SSOUserResult(payload: String, signature: String) extends Product with Serializable

    

33. case class SearchResponse(topics: Array[SearchResponseTopic], posts: Array[SearchResponsePost], users: Array[SearchResponseUsers], categories: Array[SearchResponseCategories], groupedSearchResult: GroupedSearchResult) extends Product with Serializable

    

34. case class SearchResponseCategories(id: Long) extends Product with Serializable

    

35. case class SearchResponsePost(id: Long, name: Option[String] = None, username: String, avatarTemplate: Option[String] = None, createdAt: Option[String] = None, cooked: String, likeCount: Int, blurb: String, postNumber: Int, topicId: Long) extends Product with Serializable

    

36. case class SearchResponseTopic(id: Long, title: String, fancyTitle: String, slug: String, postsCount: Int, replyCount: Int, highestPostNumber: Int, imageUrl: String, createdAt: OffsetDateTime, lastPostedAt: OffsetDateTime, bumped: Boolean, bumpedAt: OffsetDateTime, unseen: Boolean, pinned: Boolean, unpinned: Boolean, visible: Boolean, closed: Boolean, archived: Boolean, bookmarked: Boolean, liked: Option[Boolean] = None, views: Int, likeCount: Int, hasSummary: Boolean, archetype: String, lastPosterUsername: Option[String] = None, categoryId: Option[Int] = None, pinnedGlobally: Boolean, tags: Array[String], hasAcceptedAnswer: Boolean) extends Product with Serializable

    

37. case class SearchResponseUsers(id: Long) extends Product with Serializable

    

38. case class SignatureNotMatchedException(msg: String) extends Exception with Product with Serializable

    

39. case class SuspendUser(duration: Int, reason: String) extends SerializableAsJson with Product with Serializable

    

40. case class Topic(id: Int, title: String, slug: String, categoryId: Int, createdAt: OffsetDateTime, postStream: Option[PostStream] = None) extends Product with Serializable

    

41. case class TopicList(topics: Array[Topic]) extends Product with Serializable

    

42. case class TopicListContainer(topicList: TopicList) extends Product with Serializable

    

43. case class UpdateEmail(email: String, apiKey: String, apiUsername: String) extends SerializableAsJson with Product with Serializable

    

44. case class UpdateTrustLevel(userId: Int, level: Int) extends SerializableAsJson with Product with Serializable

    

45. case class UpdateUserStatus(success: String, user: User) extends SerializableAsJson with Product with Serializable

    

    Annotations

    @JsonIgnoreProperties()

46. case class UpdateUsername(newUsername: String, apiKey: String) extends SerializableAsJson with Product with Serializable

    

47. case class User(id: Int, username: String, uploadedAvatarId: Option[Int] = None, avatarTemplate: Option[String], name: Option[String], email: Option[String], lastPostedAt: Option[OffsetDateTime] = None, lastSeenAt: Option[OffsetDateTime] = None, bioCooked: Option[String] = None, createdAt: OffsetDateTime, canEdit: Boolean, canEditUsername: Boolean, canEditEmail: Boolean, canEditName: Boolean, canSendPrivateMessageToUser: Boolean, bioExcerpt: String, trustLevel: Int, moderator: Boolean, admin: Boolean, title: Option[String] = None, badgeCount: Int, hasTitleBadges: Boolean, numberOfDeletedPosts: Int, numberOfFlaggedPosts: Int, numberOfFlagsGiven: Int, numberOfSuspensions: Int, locale: Option[String] = None, emailDigests: Boolean, emailPrivateMessages: Boolean, emailDirect: Boolean, emailAlways: Boolean, digestAfterDays: Int, mailingListMode: Boolean, autoTrackTopicsAfterMsecs: Long, newTopicDurationMinutes: Int, externalLinksInNewTab: Boolean, dynamicFavicon: Boolean, enableQuoting: Boolean, mutedCategoryIds: Array[Int], trackedCategoryIds: Array[Int], watchedCategoryIds: Array[Int], privateMessagesStats: Map[String, Int], disableJumpReply: Boolean, gravatarAvatarUploadId: Option[Int] = None, custom_avatar_upload_id: Option[Int] = None, groups: Array[Group]) extends BasicUser with Product with Serializable

    

48. case class UserDetail(badges: Array[Badge], user: User) extends SerializableAsJson with Product with Serializable