Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coadler/played

Track playing statuses of users in your Discord
https://github.com/coadler/played

Last synced: 13 days ago
JSON representation

Track playing statuses of users in your Discord

Awesome Lists containing this project

README

        

# Protocol Documentation

## Table of Contents

- [played.proto](#played.proto)
- [AddUserRequest](#played.AddUserRequest)
- [AddUserResponse](#played.AddUserResponse)
- [CheckWhiteListResponse](#played.CheckWhiteListResponse)
- [CheckWhitelistRequest](#played.CheckWhitelistRequest)
- [GameEntry](#played.GameEntry)
- [GameEntryPublic](#played.GameEntryPublic)
- [GetPlayedRequest](#played.GetPlayedRequest)
- [GetPlayedResponse](#played.GetPlayedResponse)
- [RemoveUserRequest](#played.RemoveUserRequest)
- [RemoveUserResponse](#played.RemoveUserResponse)
- [SendPlayedRequest](#played.SendPlayedRequest)
- [SendPlayedResponse](#played.SendPlayedResponse)



- [Played](#played.Played)

- [Scalar Value Types](#scalar-value-types)


Top

## played.proto

### AddUserRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user | [string](#string) | | |

### AddUserResponse

### CheckWhiteListResponse

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| whitelisted | [bool](#bool) | | |

### CheckWhitelistRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user | [string](#string) | | |

### GameEntry

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | |
| dur | [int32](#int32) | | |

### GameEntryPublic

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | |
| dur | [string](#string) | | |

### GetPlayedRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user | [string](#string) | | |

### GetPlayedResponse

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| games | [GameEntryPublic](#played.GameEntryPublic) | repeated | |
| first | [string](#string) | | |
| last | [string](#string) | | |

### RemoveUserRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user | [string](#string) | | |

### RemoveUserResponse

### SendPlayedRequest

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user | [string](#string) | | |
| game | [string](#string) | | |

### SendPlayedResponse

### Played

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| SendPlayed | [SendPlayedRequest](#played.SendPlayedRequest) | [SendPlayedResponse](#played.SendPlayedRequest) | |
| GetPlayed | [GetPlayedRequest](#played.GetPlayedRequest) | [GetPlayedResponse](#played.GetPlayedRequest) | |
| AddUser | [AddUserRequest](#played.AddUserRequest) | [AddUserResponse](#played.AddUserRequest) | |
| RemoveUser | [RemoveUserRequest](#played.RemoveUserRequest) | [RemoveUserResponse](#played.RemoveUserRequest) | |
| CheckWhitelist | [CheckWhitelistRequest](#played.CheckWhitelistRequest) | [CheckWhiteListResponse](#played.CheckWhitelistRequest) | |

## Scalar Value Types

| .proto Type | Notes | C++ Type | Java Type | Python Type |
| ----------- | ----- | -------- | --------- | ----------- |
| double | | double | double | float |
| float | | float | float | float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
| sfixed32 | Always four bytes. | int32 | int | int |
| sfixed64 | Always eight bytes. | int64 | long | int/long |
| bool | | bool | boolean | boolean |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |