summaryrefslogtreecommitdiffstats
path: root/examples/oauth/redditclient/doc/src/qtnetworkauth-redditclient.qdoc
blob: 85acf84c7ed7390cbfbe2e9c08cf9f6916c5f251 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \example redditclient
    \title Reddit Example
    \ingroup examples-qtnetworkauth
    \brief Demonstrates authenticating with OAuth 2 to access Reddit.
    \excludefromcreator
    \image redditclient-example.png Screenshot of the example

    The \e {Reddit} example uses OAuth 2, as supported by
    \l {Qt Network Authorization}, to sign in to Reddit and display the
    Reddit posts (in text format) associated with the authenticated user.

    To use this example, a consumer key from Reddit is needed.
    To register the application visit https://www.reddit.com/prefs/apps/.
    \note Choose \e {installed app} when creating the application.
    \note Set the redirect URI to \e http://127.0.0.1:1337/ in Reddit settings.

    \include examples-run.qdocinc
*/