Skip to content

Latest commit

 

History

History
307 lines (206 loc) · 11 KB

CommunityContentApi.md

File metadata and controls

307 lines (206 loc) · 11 KB
Raw

destiny2_api.api.CommunityContentApi

Load the API package

import 'package:destiny2_api/api.dart';

All URIs are relative to https://www.bungie.net/Platform

Method HTTP request Description
communityContentGetCommunityContent GET /CommunityContent/Get/{sort}/{mediaFilter}/{page}/
communityContentGetCommunityLiveStatuses GET /CommunityContent/Live/All/{partnershipType}/{sort}/{page}/
communityContentGetCommunityLiveStatusesForClanmates GET /CommunityContent/Live/Clan/{partnershipType}/{sort}/{page}/
communityContentGetCommunityLiveStatusesForFriends GET /CommunityContent/Live/Friends/{partnershipType}/{sort}/{page}/
communityContentGetFeaturedCommunityLiveStatuses GET /CommunityContent/Live/Featured/{partnershipType}/{sort}/{page}/
communityContentGetStreamingStatusForMember GET /CommunityContent/Live/Users/{partnershipType}/{membershipType}/{membershipId}/

communityContentGetCommunityContent

InlineResponse20010 communityContentGetCommunityContent(mediaFilter, page, sort)

Returns community content.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var mediaFilter = 56; // int | The type of media to get
var page = 56; // int | Zero based page
var sort = 56; // int | The sort mode.

try { 
    var result = api_instance.communityContentGetCommunityContent(mediaFilter, page, sort);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetCommunityContent: $e\n");
}

Parameters

Name Type Description Notes
mediaFilter int The type of media to get
page int Zero based page
sort int The sort mode.

Return type

InlineResponse20010

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

communityContentGetCommunityLiveStatuses

InlineResponse20060 communityContentGetCommunityLiveStatuses(page, partnershipType, sort, modeHash, streamLocale)

Returns info about community members who are live streaming.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var page = 56; // int | Zero based page.
var partnershipType = 56; // int | The type of partnership for which the status should be returned.
var sort = 56; // int | The sort mode.
var modeHash = 56; // int | The hash of the Activity Mode for which streams should be retrieved. Don't pass it in or pass 0 to not filter by mode.
var streamLocale = streamLocale_example; // String | The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale.

try { 
    var result = api_instance.communityContentGetCommunityLiveStatuses(page, partnershipType, sort, modeHash, streamLocale);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetCommunityLiveStatuses: $e\n");
}

Parameters

Name Type Description Notes
page int Zero based page.
partnershipType int The type of partnership for which the status should be returned.
sort int The sort mode.
modeHash int The hash of the Activity Mode for which streams should be retrieved. Don't pass it in or pass 0 to not filter by mode. [optional]
streamLocale String The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale. [optional]

Return type

InlineResponse20060

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

communityContentGetCommunityLiveStatusesForClanmates

InlineResponse20060 communityContentGetCommunityLiveStatusesForClanmates(page, partnershipType, sort)

Returns info about community members who are live streaming in your clans.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var page = 56; // int | Zero based page.
var partnershipType = 56; // int | The type of partnership for which the status should be returned.
var sort = 56; // int | The sort mode.

try { 
    var result = api_instance.communityContentGetCommunityLiveStatusesForClanmates(page, partnershipType, sort);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetCommunityLiveStatusesForClanmates: $e\n");
}

Parameters

Name Type Description Notes
page int Zero based page.
partnershipType int The type of partnership for which the status should be returned.
sort int The sort mode.

Return type

InlineResponse20060

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

communityContentGetCommunityLiveStatusesForFriends

InlineResponse20060 communityContentGetCommunityLiveStatusesForFriends(page, partnershipType, sort)

Returns info about community members who are live streaming among your friends.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var page = 56; // int | Zero based page.
var partnershipType = 56; // int | The type of partnership for which the status should be returned.
var sort = 56; // int | The sort mode.

try { 
    var result = api_instance.communityContentGetCommunityLiveStatusesForFriends(page, partnershipType, sort);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetCommunityLiveStatusesForFriends: $e\n");
}

Parameters

Name Type Description Notes
page int Zero based page.
partnershipType int The type of partnership for which the status should be returned.
sort int The sort mode.

Return type

InlineResponse20060

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

communityContentGetFeaturedCommunityLiveStatuses

InlineResponse20060 communityContentGetFeaturedCommunityLiveStatuses(page, partnershipType, sort, streamLocale)

Returns info about Featured live streams.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var page = 56; // int | Zero based page.
var partnershipType = 56; // int | The type of partnership for which the status should be returned.
var sort = 56; // int | The sort mode.
var streamLocale = streamLocale_example; // String | The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale.

try { 
    var result = api_instance.communityContentGetFeaturedCommunityLiveStatuses(page, partnershipType, sort, streamLocale);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetFeaturedCommunityLiveStatuses: $e\n");
}

Parameters

Name Type Description Notes
page int Zero based page.
partnershipType int The type of partnership for which the status should be returned.
sort int The sort mode.
streamLocale String The locale for streams you'd like to see. Don't pass this to fall back on your BNet locale. Pass 'ALL' to not filter by locale. [optional]

Return type

InlineResponse20060

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

communityContentGetStreamingStatusForMember

InlineResponse20061 communityContentGetStreamingStatusForMember(membershipId, membershipType, partnershipType)

Gets the Live Streaming status of a particular Account and Membership Type.

Example

import 'package:destiny2_api/api.dart';

var api_instance = new CommunityContentApi();
var membershipId = 789; // int | The membershipId related to that type.
var membershipType = 56; // int | The type of account for which info will be extracted.
var partnershipType = 56; // int | The type of partnership for which info will be extracted.

try { 
    var result = api_instance.communityContentGetStreamingStatusForMember(membershipId, membershipType, partnershipType);
    print(result);
} catch (e) {
    print("Exception when calling CommunityContentApi->communityContentGetStreamingStatusForMember: $e\n");
}

Parameters

Name Type Description Notes
membershipId int The membershipId related to that type.
membershipType int The type of account for which info will be extracted.
partnershipType int The type of partnership for which info will be extracted.

Return type

InlineResponse20061

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]