Skip to content

GlobalAlerts HTTP Routes

GlobalAlertsRouteHttpRequests

Source code in src/bungio/http/routes/global_alerts.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class GlobalAlertsRouteHttpRequests:
    request: Callable[..., Coroutine]

    async def get_global_alerts(
        self, includestreaming: Optional[bool] = None, auth: Optional[AuthData] = None, *args, **kwargs
    ) -> dict:
        """
        Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

        Args:
            includestreaming: Determines whether Streaming Alerts are included in results
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Raises:
            NotFound: 404 request
            BadRequest: 400 request
            InvalidAuthentication: If authentication is invalid
            TimeoutException: If no connection could be made
            BungieDead: Servers are down
            AuthenticationTooSlow: The authentication key has expired
            BungieException: Relaying the bungie error

        Returns:
            The json response
        """

        return await self.request(
            Route(path="/GlobalAlerts/", method="GET", includestreaming=includestreaming, auth=auth)
        )

get_global_alerts(includestreaming=None, auth=None, *args, **kwargs) async

Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

Parameters:

Name Type Description Default
includestreaming Optional[bool]

Determines whether Streaming Alerts are included in results

 None
auth Optional[AuthData]

Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

 None

Raises:

Type Description
NotFound

404 request
BadRequest

400 request
InvalidAuthentication

If authentication is invalid
TimeoutException

If no connection could be made
BungieDead

Servers are down
AuthenticationTooSlow

The authentication key has expired
BungieException

Relaying the bungie error

Returns:

Type Description
dict

The json response
Source code in src/bungio/http/routes/global_alerts.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
async def get_global_alerts(
    self, includestreaming: Optional[bool] = None, auth: Optional[AuthData] = None, *args, **kwargs
) -> dict:
    """
    Gets any active global alert for display in the forum banners, help pages, etc. Usually used for DOC alerts.

    Args:
        includestreaming: Determines whether Streaming Alerts are included in results
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Raises:
        NotFound: 404 request
        BadRequest: 400 request
        InvalidAuthentication: If authentication is invalid
        TimeoutException: If no connection could be made
        BungieDead: Servers are down
        AuthenticationTooSlow: The authentication key has expired
        BungieException: Relaying the bungie error

    Returns:
        The json response
    """

    return await self.request(
        Route(path="/GlobalAlerts/", method="GET", includestreaming=includestreaming, auth=auth)
    )