Package com.microsoft.graph.subscriptions

Class SubscriptionsRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
com.microsoft.graph.subscriptions.SubscriptionsRequestBuilder
@Generated("com.microsoft.kiota") public class SubscriptionsRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Provides operations to manage the collection of subscription entities.

  • Constructor Details

    • SubscriptionsRequestBuilder

      public SubscriptionsRequestBuilder(@Nonnull HashMap<String,Object> pathParameters, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new SubscriptionsRequestBuilder and sets the default values.
      Parameters:
      pathParameters - Path parameters for the request
      requestAdapter - The request adapter to use to execute the requests.

    • SubscriptionsRequestBuilder

      public SubscriptionsRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new SubscriptionsRequestBuilder and sets the default values.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      requestAdapter - The request adapter to use to execute the requests.

  • Method Details

    • bySubscriptionId

      @Nonnull public SubscriptionItemRequestBuilder bySubscriptionId(@Nonnull String subscriptionId)
      Provides operations to manage the collection of subscription entities.
      Parameters:
      subscriptionId - The unique identifier of subscription
      Returns:
      a SubscriptionItemRequestBuilder

    • get

      @Nullable public SubscriptionCollectionResponse get()
      Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section.
      Returns:
      a SubscriptionCollectionResponse
      Throws:
      ODataError - When receiving a 4XX or 5XX status code
      See Also:

    • get

      @Nullable public SubscriptionCollectionResponse get(@Nullable Consumer<SubscriptionsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section.
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a SubscriptionCollectionResponse
      Throws:
      ODataError - When receiving a 4XX or 5XX status code
      See Also:

    • post

      @Nullable public Subscription post(@Nonnull Subscription body)
      Subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources.
      Parameters:
      body - The request body
      Returns:
      a Subscription
      Throws:
      ODataError - When receiving a 4XX or 5XX status code
      See Also:

    • post

      @Nullable public Subscription post(@Nonnull Subscription body, @Nullable Consumer<SubscriptionsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources.
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a Subscription
      Throws:
      ODataError - When receiving a 4XX or 5XX status code
      See Also:

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section.
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<SubscriptionsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Retrieve the properties and relationships of webhook subscriptions, based on the app ID, the user, and the user's role with a tenant. The content of the response depends on the context in which the app is calling; for details, see the scenarios in the Permissions section.
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull Subscription body)
      Subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources.
      Parameters:
      body - The request body
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull Subscription body, @Nullable Consumer<SubscriptionsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Subscribes a listener application to receive change notifications when the requested type of changes occur to the specified resource in Microsoft Graph. To identify the resources for which you can create subscriptions and the limitations on subscriptions, see Set up notifications for changes in resource data: Supported resources. Some resources support rich notifications, that is, notifications that include resource data. For more information about these resources, see Set up change notifications that include resource data: Supported resources.
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public SubscriptionsRequestBuilder withUrl(@Nonnull String rawUrl)
      Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      Returns:
      a SubscriptionsRequestBuilder