Skip to content

Commit

Permalink
Merge #228
Browse files Browse the repository at this point in the history
228: docs: added readme for japanese (#213) r=myConsciousness a=myConsciousness

# 1. Description

<!-- Provide a description of what this PR is doing.
If you're modifying existing behavior, describe the existing behavior, how this PR is changing it,
and what motivated the change. If this is a breaking change, specify explicitly which APIs have been
changed. -->

## 1.1. Checklist

<!-- Before you create this PR confirm that it meets all requirements listed below by checking the
relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. -->

- [x] The title of my PR starts with a [Conventional Commit] prefix (`fix:`, `feat:`, `docs:` etc).
- [x] I have read the [Contributor Guide] and followed the process outlined for submitting PRs.
- [x] I have updated/added tests for ALL new/updated/fixed functionality.
- [x] I have updated/added relevant documentation in `docs` and added dartdoc comments with `///`.
- [x] I have updated/added relevant examples in `examples`.

## 1.2. Breaking Change

<!-- Does your PR require users to manually update their apps to accommodate your change?

If the PR is a breaking change this should be indicated with suffix "!"  (for example, `feat!:`, `fix!:`). See [Conventional Commit] for details.
-->

- [ ] Yes, this is a breaking change.
- [x] No, this is _not_ a breaking change.

## 1.3. Related Issues

<!-- Provide a list of issues related to this PR from the [issue database].
Indicate which of these issues are resolved or fixed by this PR, i.e. Fixes #xxxx* !-->

<!-- Links -->

[issue database]: https://github.com/twitter-dart/twitter-api-v2/issues
[contributor guide]: https://github.com/twitter-dart/twitter-api-v2/blob/main/CONTRIBUTING.md
[style guide]: https://github.com/twitter-dart/twitter-api-v2/blob/main/STYLEGUIDE.md
[conventional commit]: https://conventionalcommits.org


Co-authored-by: myConsciousness <kato.shinya.dev@gmail.com>
  • Loading branch information
bors[bot] and myConsciousness authored Jun 8, 2022
2 parents 3109a27 + dc9028f commit cccaf68
Show file tree
Hide file tree
Showing 2 changed files with 644 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@

---

| English | [日本語](https://github.com/twitter-dart/twitter-api-v2/blob/main/i18n/README-JA.md) |

---

<!-- TOC -->

- [1. Guide 🌎](#1-guide-)
Expand All @@ -41,7 +45,7 @@
- [1.1.3. Implementation](#113-implementation)
- [1.2. Supported Endpoints 👀](#12-supported-endpoints-)
- [1.2.1. Tweets Service](#121-tweets-service)
- [1.2.1.1. Manage Tweet](#1211-manage-tweet)
- [1.2.1.1. Tweet](#1211-tweet)
- [1.2.1.2. Likes](#1212-likes)
- [1.2.1.3. Retweets](#1213-retweets)
- [1.2.1.4. Quote Tweets](#1214-quote-tweets)
Expand All @@ -65,7 +69,7 @@
- [1.2.4.1. Lookup Lists](#1241-lookup-lists)
- [1.2.4.2. Pinnings](#1242-pinnings)
- [1.2.4.3. Tweet Lookup](#1243-tweet-lookup)
- [1.2.4.4. Manage](#1244-manage)
- [1.2.4.4. List Manage](#1244-list-manage)
- [1.2.4.5. Follows](#1245-follows)
- [1.2.4.6. Members](#1246-members)
- [1.2.5. Compliance Service](#125-compliance-service)
Expand Down Expand Up @@ -199,7 +203,7 @@ void main() async {

### 1.2.1. Tweets Service

#### 1.2.1.1. Manage Tweet
#### 1.2.1.1. Tweet

| Endpoint | Method Name |
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
Expand Down Expand Up @@ -365,7 +369,7 @@ void main() async {
| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [GET /2/lists/:id/tweets](https://developer.twitter.com/en/docs/twitter-api/lists/list-tweets/api-reference/get-lists-id-tweets) | [lookupTweets](https://pub.dev/documentation/twitter_api_v2/latest/twitter_api_v2/ListsService/lookupTweets.html) |

#### 1.2.4.4. Manage
#### 1.2.4.4. List Manage

| Endpoint | Method Name |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -410,14 +414,14 @@ void main() async {

### 1.3.1. Method Names

`twitter_api_v2` uses the following standard prefixes depending on endpoint characteristics. It's very easy to find the method corresponding to the endpoint you want to use!
`twitter_api_v2` uses the following standard prefixes depending on endpoint characteristics. So it's very easy to find the method corresponding to the endpoint you want to use!

| Prefix | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **lookup** | This prefix is attached to the endpoint performing the search.</br> However, it's distinguished from the higher-performance Search endpoint. |
| **search** | This prefix is attached to high-performance Search endpoints. |
| **connect** | This prefix is attached to the endpoint performing the high-performance streaming. |
| **count** | This prefix is attached to the endpoint that counts tweets, etc. |
| **lookup** | This prefix is attached to endpoints that reference tweets, users, etc. |
| **search** | This prefix is attached to endpoints that perform extensive searches. |
| **connect** | This prefix is attached to endpoints with high-performance streaming. |
| **count** | This prefix is attached to the endpoint that counts a particular item. |
| **create** | This prefix is attached to the endpoint performing the create state such as `Tweet` and `Follow`. |
| **destroy** | This prefix is attached to the endpoint performing the destroy state such as `Tweet` and `Follow`. |
| **update** | This prefix is attached to the endpoint performing the update state. |
Expand Down Expand Up @@ -500,7 +504,7 @@ You can see more details about `expansions` from [Official Documentation](https:

`Twitter API v2.0` supports a very interesting specification, allowing users to control the amount of data contained in the response object for each endpoint depending on the situation. It's called `fields`, and this library supports this specification.

Basically it can be used in endpoints that perform GET communication such as `lookup` and `search` processing. Some fields may also be included in the `includes` property of [TwitterResponse](https://pub.dev/documentation/twitter_api_v2/latest/twitter_api_v2/TwitterResponse-class.html).
Basically it can be used in endpoints that perform GET communication such as `lookup` and `search` processing. Some fields may also be included in the `includes` field of [TwitterResponse](https://pub.dev/documentation/twitter_api_v2/latest/twitter_api_v2/TwitterResponse-class.html).

You can use `fields` like below:

Expand Down
Loading

0 comments on commit cccaf68

Please sign in to comment.