Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Asynchronous services that are called in callback manner.

• oneof value

  • TopicListRequest topic_list = 1

    Get topics in given forum.

  • TopicDetailsRequest topic_details = 2

    Get posts in given topic.

  • SubforumFilterRequest subforum_filter = 3

    Set filter for subforums.

  • ForumListRequest forum_list = 4

    Get all forums.

  • RemoteUserRequest remote_user = 5

    Find user info remotely.

  • PostVoteRequest post_vote = 6

    Do voting to posts.

  • TopicHistoryRequest topic_history = 7

    Get history of visited topics.

  • HotTopicListRequest hot_topic_list = 8

    Get hot topics in given forum.

  • ForumSearchRequest forum_search = 9

    Search for a specific forum.

  • FavoriteTopicListRequest favorite_topic_list = 10

    Get favorite topics.

  • TopicFavorRequest topic_favor = 11

    Mark a topic as favored.

  • PostReplyFetchContentRequest post_reply_fetch_content = 12

    Fetch the initial content for a posting action.

  • PostReplyRequest post_reply = 13

    Do posting to some topic or forum.

  • FetchNotificationRequest fetch_notification = 14

    Get all notifications.

  • UploadAttachmentRequest upload_attachment = 15

    Upload attachments before posting.

  • UserTopicListRequest user_topic_list = 16

    Get topics of given user.

  • UserPostListRequest user_post_list = 17

    Get posts of given user.

  • ShortMessageListRequest short_message_list = 18

    Get short message conversations of current user.

  • ShortMessageDetailsRequest short_message_details = 19

    Get short message posts of a conversation.

  • ShortMessagePostRequest short_message_post = 20

    Do posting to some short message post or conversation.

  • TopicSearchRequest topic_search = 21

    Search for topics with some keyword in specific forum or all forums.

  • ClockInRequest clock_in = 22

    Sign in (clock in) for today.

  • CacheRequest cache = 23

    Clear or check the cache.

  • FavoriteFolderListRequest favorite_folder_list = 24

    List favorite topic folders.

  • FavoriteFolderModifyRequest favorite_folder_modify = 25

    Modify a favorite topic folder.

  • FavoriteFolderCreateRequest favorite_folder_create = 26

    Create a favorite topic folder.

  • UserSignatureUpdateRequest user_signature_update = 27

    Update the signature of the current user.

  • FavoriteForumListRequest favorite_forum_list = 28

    Get favorite forums (forum_favor2).

  • FavoriteForumModifyRequest favorite_forum_modify = 29

    Add or remove a favorite forum (forum_favor2).

Used in: Post

• string url = 1

• uint64 size = 2

• string type = 3

Used in: AuthRequest

• string uid = 1

• string token = 2

• int32 device = 3

• string cached_name = 4

  Cached user name from last authentication.

Used in: SyncRequest

• optional AuthInfo info = 1

(message has no fields)

• string word = 1

Used in: CacheRequest

• CHECK = 0

• CLEAR = 1

Used in: AsyncRequest

• CacheType type = 1

• CacheOperation operation = 2

• uint64 items = 1

• uint64 total_size = 2

Used in: CacheRequest

• ALL = 0

• TOPIC_HISTORY = 1

• TOPIC_DETAILS = 2

• NOTIFICATION = 3

Used in: ForumListResponse

• string id = 1

• string name = 2

• repeated Forum forums = 3

Used in: AsyncRequest

(message has no fields)

• string date = 1

• bool is_first_time = 2

Used in: ConfigureRequest

• string document_dir_path = 1

  Path to an App-local writable directory.

Used in: SyncRequest

• optional Configuration config = 1

• bool debug = 2

  Whether this is a debugging environment.

• optional string error = 1

Used in: SyncRequest

• string raw = 1

• optional PostContent content = 1

Used in: Post, RequestOption

• APPLE = 0

  From official NGA iOS App or MNGA (by default).

• ANDROID = 1

• DESKTOP = 2

• WINDOWS_PHONE = 3

• CUSTOM = 100

  Used for custom User-Agent.

• string code = 1

• string info = 2

• string detailed = 3

Used in: AsyncRequest

• string name = 1

• bool set_default = 2

• string folder_id = 1

Used in: AsyncRequest

(message has no fields)

• repeated FavoriteTopicFolder folders = 1

Used in: AsyncRequest

• string folder_id = 1

• oneof change

  • string rename = 2

  • bool set_default = 3

  • bool delete = 4

(message has no fields)

Used in: AsyncRequest

(message has no fields)

• repeated Forum forums = 1

Used in: AsyncRequest

• FavoriteForumModifyRequest.Operation operation = 1

• optional ForumId id = 2

Used in: FavoriteForumModifyRequest

• ADD = 0

• DEL = 1

(message has no fields)

Used in: FavoriteFolderListResponse

• string id = 1

• string name = 2

• uint32 topic_count = 3

• bool is_default = 4

  Default folder can also be listed with `favor=1`.

Used in: AsyncRequest

• uint32 page = 1

• string folder_id = 2

• repeated Topic topics = 1

• uint32 pages = 2

Used in: AsyncRequest

(message has no fields)

• repeated Notification notis = 1

Used in: Category, FavoriteForumListResponse, ForumSearchResponse, HotTopicListResponse, Subforum, Topic, TopicListResponse

• optional ForumId id = 1

• string name = 2

• string info = 3

• string icon_url = 4

• string topped_topic_id = 5

Used in: FavoriteForumModifyRequest, Forum, HotTopicListRequest, PostReplyAction, TopicListRequest, TopicSearchRequest

• oneof id

  todo: no oneof

  • string fid = 1

  • string stid = 2

Used in: AsyncRequest

(message has no fields)

• repeated Category categories = 1

Used in: AsyncRequest

• string key = 1

• repeated Forum forums = 1

Used in: AsyncRequest

• optional ForumId id = 1

• HotTopicListRequest.DateRange range = 2

  Only see topics posted in this date range.

• optional uint32 fetch_page_limit = 3

  Maximum page of topics to collect.

• optional uint64 limit = 4

Used in: HotTopicListRequest

• DAY = 0

• WEEK = 1

• MONTH = 2

• repeated Topic topics = 1

• optional Forum forum = 2

  Details of the given forum id.

Used in: SyncRequest

(message has no fields)

(message has no fields)

Post with much less information, used for posts of some user.

Used in: TopicWithLightPost

• optional PostId id = 1

• string author_id = 2

• optional PostContent content = 3

• uint64 post_date = 4

Used in: SyncRequest

• string user_id = 1

• optional User user = 1

Used in: SyncRequest

• repeated string ids = 1

• bool read = 2

(message has no fields)

MNGA-only mock APIs.

• oneof value

  • MockApi.TopicList topic_list = 1

  • MockApi.TopicDetails topic_details = 2

Used in: MockApi

• string id = 1

Used in: MockApi

• string id = 1

Used in: FetchNotificationResponse

• string id = 9

• Notification.Type type = 1

• optional User other_user = 2

• optional PostId post_id = 3

  ID of our post.

• optional PostId other_post_id = 4

  ID of other's post.

• optional Subject topic_subject = 5

• uint64 timestamp = 6

• uint32 page = 7

  The page of other's post in the topic.

• bool read = 8

  Whether this notification has been read.

Used in: Notification

• UNKNOWN = 0

• REPLY_TOPIC = 1

  One replies to user's topic.

• REPLY_POST = 2

  One replies to user's post.

• AT_TOPIC = 7

  One @-mentions user in a topic.

• AT_POST = 8

  One @-mentions user in a post.

• SHORT_MESSAGE_START = 10

  One starts a new short message.

• SHORT_MESSAGE = 11

  One replies to a short message.

• VOTE = 17

  User's post receives some votes.

Used in: TopicDetailsResponse

• optional PostId id = 6

• uint32 floor = 1

  This might be inaccurate if it's from a special topic

• string author_id = 2

  details request with other arguments specified.

• optional PostContent content = 3

• uint64 post_date = 4

  The timestamp of the posting.

• uint32 score = 5

  The number of upvotes.

• VoteState vote_state = 7

  The vote state cached from current client before.

• repeated Post hot_replies = 8

  Hot replies only exist in the main floor.

• repeated Post comments = 12

  Inline replies.

• Device device = 9

• string alter_info = 10

  This post has been altered if it's not empty.

• uint32 at_page = 11

  The page which this post belongs to.

• repeated Attachment attachments = 13

• string fid = 14

  The id of the post's parent forum, mainly used for

Attachments that have been already uploaded, but not posted yet.

Used in: PostReplyRequest, UploadAttachmentResponse

• string name = 1

• string url = 2

• string check = 3

  Verification code for posting this attachment.

Rich content parsed from bbcode.

Used in: ContentParseResponse, LightPost, Post, ShortMessagePost, User

• repeated Span spans = 1

• string raw = 2

  Raw bbcode representation of this content.

• string error = 3

  Parse error.

Used in: LightPost, Notification, Post, PostReplyAction, PostVoteRequest

• string pid = 1

  The id of this post. If `pid` is 0, it's the main floor of

• string tid = 2

  this `topic`. Otherwise, it's globally unique.

  The id of the topic where this post resides.

Used in: PostReplyFetchContentRequest, PostReplyRequest, UploadAttachmentRequest

• PostReplyAction.Operation operation = 1

• optional PostId post_id = 2

  Used if operation is not `NEW`.

• optional ForumId forum_id = 3

  Used if operation is `NEW`.

• optional PostReplyVerbatim verbatim = 4

Used in: PostReplyAction

• REPLY = 0

• QUOTE = 1

• MODIFY = 2

• COMMENT = 3

• NEW = 4

• REPORT = 5

Used in: AsyncRequest

• optional PostReplyAction action = 1

• string content = 1

• optional string subject = 2

  Used for topics.

• optional PostReplyVerbatim verbatim = 3

  Extra info to keep and pass verbatim.

Used in: AsyncRequest

• optional PostReplyAction action = 1

• string content = 2

• optional string subject = 3

• repeated PostAttachment attachments = 4

• bool anonymous = 5

  Whether to post as anonymous identity.

• string message = 1

Extra info for posting action from fetching step, which should be passed verbatim when do posting.

Used in: PostReplyAction, PostReplyFetchContentResponse

• bool modify_append = 1

  Whether this modification can only be appendent due

• string auth = 2

  to exceeding of date, or in-place.

  Code used for uploading attachments.

• string attach_url = 3

  URL where attachments should be uploaded to.

Used in: AsyncRequest

• PostVoteRequest.Operation operation = 1

• optional PostId post_id = 2

Used in: PostVoteRequest

• UPVOTE = 0

• DOWNVOTE = 1

• sint32 delta = 1

  Delta to add to the current score.

• optional string error = 2

  not used

• VoteState state = 3

  Vote state after voting.

Used in: AsyncRequest

• string user_id = 1

  Request by ID.

• string user_name = 2

  Request by name.

• optional User user = 1

Used in: SetRequestOptionRequest

• string base_url_v2 = 1

• Device device = 2

• string custom_ua = 5

  Only used when `device` is `CUSTOM`.

Used in: SyncRequest

• optional RequestOption option = 1

(message has no fields)

Info of one short message conversation, contains a list of posts.

Used in: ShortMessageListResponse

• string id = 1

• string subject = 2

• string from_id = 3

• string from_name = 4

• uint64 post_date = 5

• uint64 last_post_date = 6

• uint32 post_num = 7

• repeated string ids = 8

• repeated UserName user_names = 9

Used in: AsyncRequest

• string id = 1

• uint32 page = 2

• repeated ShortMessagePost posts = 1

• uint32 pages = 2

• repeated User users = 3

Used in: AsyncRequest

• uint32 page = 1

• repeated ShortMessage messages = 1

• uint32 pages = 2

Used in: ShortMessageDetailsResponse

• string id = 1

• string author_id = 2

• string subject = 3

• optional PostContent content = 4

• uint64 post_date = 5

Used in: ShortMessagePostRequest

• ShortMessagePostAction.Operation operation = 1

• string mid = 2

  Message id to reply to, used if operation is `REPLY`.

• string single_to = 3

  UID to send to, used if operation is `NEW_SINGLE_TO`.

Used in: ShortMessagePostAction

• REPLY = 0

• NEW = 1

• NEW_SINGLE_TO = 2

  Send to exactly single user.

Used in: AsyncRequest

• optional ShortMessagePostAction action = 1

• string content = 2

• string subject = 3

• repeated string to = 4

  Used if `action.operation`` is `NEW`

(message has no fields)

Part of rich contents.

Used in: PostContent, Span.Tagged

• oneof value

  • Span.Plain plain = 1

  • Span.BreakLine break_line = 2

  • Span.Sticker sticker = 3

  • Span.Tagged tagged = 4

Used in: Span

(message has no fields)

Used in: Span

• string text = 1

Used in: Span

• string name = 1

Used in: Span

• string tag = 1

• repeated string attributes = 2

• repeated string complex_attributes = 4

• repeated Span spans = 3

  Children span nodes.

Children of a parent forum, can be subscribed or unsubscribed.

Used in: TopicListResponse

• optional Forum forum = 8

  Info of the subforum.

• string filter_id = 7

  ID used for sending request to (un)subcribe self.

• uint64 attributes = 4

• bool filterable = 5

  Whether this subforum is able to be unsubscribed.

• bool selected = 6

  Whether this subforum is subscribed in its parent forum.

Used in: AsyncRequest

• SubforumFilterRequest.Operation operation = 1

• string forum_id = 2

  ID of the parent forum.

• string subforum_filter_id = 3

  See `Subforum.filter_id`

Used in: SubforumFilterRequest

• SHOW = 0

  Subscribe.

• BLOCK = 1

  Unsubscribe.

(message has no fields)

Subject of a topic.

Used in: Notification, SubjectParseResponse, Topic

• repeated string tags = 1

  Leading tags of the topic.

• string content = 2

  Main content.

• repeated Subject.FontModifier font_modifiers = 3

Used in: Subject

• NONE = 0

• RED = 1

• BLUE = 2

• GREEN = 3

• ORANGE = 4

• SILVER = 5

• BOLD = 6

• ITALIC = 7

• UNDERLINE = 8

• SEMIBOLD = 128

Used in: SyncRequest

• string raw = 1

• optional Subject subject = 1

Synchronous services that return immediately.

• oneof value

  • ConfigureRequest configure = 1

    Configure and initialize logic, should be called once the app is started.

  • LocalUserRequest local_user = 2

    Find user info in locally loaded dictionary.

  • AuthRequest auth = 3

    Sync auth info to logic, should be called if current user changes.

  • ContentParseRequest content_parse = 4

    Parse string as `PostContent`.

  • SubjectParseRequest subject_parse = 5

    Parse string as `Subject` of topic.

  • MarkNotificationReadRequest mark_noti_read = 6

    Mark some notifications as read.

  • SetRequestOptionRequest set_request_option = 7

    Set options for requesting.

  • InvalidateClientRequest invalidate_client = 8

    Invalidate the global HTTP client.

  • UpdateTopicProgressRequest update_topic_progress = 9

    Update locally cached progress of a topic.

Used in: FavoriteTopicListResponse, HotTopicListResponse, TopicDetailsResponse, TopicListResponse, TopicSearchResponse, TopicSnapshot, TopicWithLightPost, UserTopicListResponse

• string id = 1

  `tid` from NGA.

• repeated string tags = 8

• string subject_content = 9

• optional Subject subject = 2

• string author_id = 3

• string author_name_raw = 4

• optional UserName author_name = 15

• uint64 post_date = 5

  Timestamp of the topic's initial posting.

• uint64 last_post_date = 6

  Timestamp of the topic's last reply from others.

• uint32 replies_num = 7

• optional Forum parent_forum = 10

  The direct parent forum of this topic, if

• optional string fav = 11

  it's not the exactly requested one.

  Code for accessing the topic even if it's hidden

• bool is_favored = 12

  or expired, if it's favored before

  See `TopicFavorResponse`

• repeated string favor_folder_ids = 16

  See `TopicFavorResponse`

• optional uint32 replies_num_last_visit = 13

• optional uint32 highest_viewed_floor = 17

  Highest floor visited locally.

• optional uint32 last_viewing_floor = 18

  Last floor visited locally.

• string fid = 14

  The id of the topic's parent forum, mainly used for

• optional Forum shortcut_forum = 19

  uploading attachments.

  If set, then this topic is a shortcut to another forum.

Used in: AsyncRequest

• string topic_id = 1

• string fav = 3

  See `Topic.fav`

• string post_id = 4

• string author_id = 5

• bool anonymous_author_only = 7

  For anonymous author only mode, set this flag,

• uint32 page = 2

  and specify the `post_id` posted by this author. `post_id` can be omitted if it's the topic author.

• bool local_cache = 6

  Whether to only request cached version of the topic.

• TopicDetailsRequest.WebApiStrategy web_api_strategy = 8

  Whether or in what circumstances to use web API.

Used in: TopicDetailsRequest

• DISABLED = 0

  Do not use web API.

• SECONDARY = 1

  If XML API returns truncated content, fallback to use web API.

• PRIMARY = 2

  Prefer to use web API, fallback to XML API if parsing failed.

• ONLY = 3

  Only use web API.

• optional Topic topic = 1

• repeated Post replies = 2

• string forum_name = 4

• uint32 pages = 3

• bool is_local_cache = 5

  Whether the replies are from local cache.

• optional string local_reason = 7

  Reason why online load is failed.

• repeated User in_place_users = 6

• string api_used = 8

Used in: AsyncRequest

• string topic_id = 1

• TopicFavorRequest.Operation operation = 2

• string folder_id = 3

  To create a new folder, use "-1".

Used in: TopicFavorRequest

• ADD = 0

• DELETE = 1

• bool is_favored = 1

  Whether `folder_ids` is non-empty.

• repeated string folder_ids = 2

  IDs of the favorite folders that the topic is in.

Used in: AsyncRequest

• uint64 limit = 1

• repeated TopicSnapshot topics = 1

Used in: AsyncRequest

• optional ForumId id = 1

• uint32 page = 2

• bool sort_subforums = 4

• TopicListRequest.Order order = 5

• bool recommended_only = 6

  Whether to only show recommended topics.

Used in: TopicListRequest

• LAST_POST = 0

  Order by the time of the last post of the topic.

• POST_DATE = 1

  Order by the initial post time of the topic.

• optional Forum forum = 4

  Details of the given forum id.

• repeated Topic topics = 1

• uint32 pages = 2

• repeated Subforum subforums = 3

Used in: AsyncRequest

• optional ForumId id = 1

  If not provided, search in all forums.

• uint32 page = 2

• bool search_content = 3

  Whether to search content for the key.

• bool recommended_only = 4

  Whether to only search recommended topics.

• string key = 5

• repeated Topic topics = 1

• uint32 pages = 2

Used in: TopicHistoryResponse

• optional Topic topic_snapshot = 1

• uint64 timestamp = 2

Combination of `Topic` and `LightPost`, used for posts of some user.

Used in: UserPostListResponse

• optional Topic topic = 1

• optional LightPost post = 2

Used in: SyncRequest

• string topic_id = 1

• uint32 highest_floor = 2

• uint32 current_floor = 3

(message has no fields)

Used in: AsyncRequest

• optional PostReplyAction action = 1

• bytes file = 2

  Data of the file.

• optional PostAttachment attachment = 1

Used in: LocalUserResponse, Notification, RemoteUserResponse, ShortMessageDetailsResponse, TopicDetailsResponse

• string id = 1

• optional UserName name = 8

• string avatar_url = 3

• uint64 reg_date = 4

  The timestamp of the user's registration.

• uint32 post_num = 5

• sint64 fame = 6

  Should be resolved as `fame / 10`.

• optional PostContent signature = 7

• string name_raw = 2

• bool mute = 9

  Whether the user is temporarily banned by NGA.

• string ip_location = 10

• bool remote = 11

  Whether this user info is fetched with a separate `remoteUser` call.

Used in: ShortMessage, Topic, User

• string normal = 1

  Original name of a user, will always be some.

• string anonymous = 2

  Anonymous representation of a user name, if exists.

Used in: AsyncRequest

• string author_id = 1

• uint32 page = 2

• repeated TopicWithLightPost tps = 1

Used in: AsyncRequest

• string signature = 1

(message has no fields)

Used in: AsyncRequest

• string author_id = 1

• uint32 page = 2

• repeated Topic topics = 1

• uint32 pages = 2

Used in: Post, PostVoteResponse

• NONE = 0

• UP = 1

• DOWN = 2