github.com/twilio/twilio-go@v1.20.1/rest/video/v1/docs/RoomsParticipantsSubscribeRulesApi.md (about)

     1  # RoomsParticipantsSubscribeRulesApi
     2  
     3  All URIs are relative to *https://video.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**FetchRoomParticipantSubscribeRule**](RoomsParticipantsSubscribeRulesApi.md#FetchRoomParticipantSubscribeRule) | **Get** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules | 
     8  [**UpdateRoomParticipantSubscribeRule**](RoomsParticipantsSubscribeRulesApi.md#UpdateRoomParticipantSubscribeRule) | **Post** /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules | 
     9  
    10  
    11  
    12  ## FetchRoomParticipantSubscribeRule
    13  
    14  > VideoV1RoomParticipantSubscribeRule FetchRoomParticipantSubscribeRule(ctx, RoomSidParticipantSid)
    15  
    16  
    17  
    18  Returns a list of Subscribe Rules for the Participant.
    19  
    20  ### Path Parameters
    21  
    22  
    23  Name | Type | Description
    24  ------------- | ------------- | -------------
    25  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26  **RoomSid** | **string** | The SID of the Room resource where the subscribe rules to fetch apply.
    27  **ParticipantSid** | **string** | The SID of the Participant resource with the subscribe rules to fetch.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a FetchRoomParticipantSubscribeRuleParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  
    37  ### Return type
    38  
    39  [**VideoV1RoomParticipantSubscribeRule**](VideoV1RoomParticipantSubscribeRule.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: Not defined
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## UpdateRoomParticipantSubscribeRule
    56  
    57  > VideoV1RoomParticipantSubscribeRule UpdateRoomParticipantSubscribeRule(ctx, RoomSidParticipantSidoptional)
    58  
    59  
    60  
    61  Update the Subscribe Rules for the Participant
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **RoomSid** | **string** | The SID of the Room resource where the subscribe rules to update apply.
    70  **ParticipantSid** | **string** | The SID of the Participant resource to update the Subscribe Rules.
    71  
    72  ### Other Parameters
    73  
    74  Other parameters are passed through a pointer to a UpdateRoomParticipantSubscribeRuleParams struct
    75  
    76  
    77  Name | Type | Description
    78  ------------- | ------------- | -------------
    79  **Rules** | [**interface{}**](interface{}.md) | A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information.
    80  
    81  ### Return type
    82  
    83  [**VideoV1RoomParticipantSubscribeRule**](VideoV1RoomParticipantSubscribeRule.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: application/x-www-form-urlencoded
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97