🔍 Code Extractor

class RenderListDataParameters

Maturity: 33

Specifies the parameters to be used to render list data as a JSON string

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/render_data_parameters.py
Lines:
4 - 50
Complexity:
moderate

Purpose

Specifies the parameters to be used to render list data as a JSON string

Source Code

class RenderListDataParameters(ClientValue):
    """Specifies the parameters to be used to render list data as a JSON string"""

    def __init__(
        self,
        add_all_fields=None,
        add_all_view_fields=None,
        add_regional_settings=None,
        add_required_fields=None,
        allow_multiple_value_filter_for_taxonomy_fields=None,
        audience_target=None,
        dates_in_utc=None,
        expand_groups=None,
        expand_user_field=None,
        filter_out_channel_folders_in_default_doc_lib=None,
    ):
        """
        :param bool add_all_fields:
        :param bool add_all_view_fields:
        :param bool add_regional_settings:
        :param bool add_required_fields: This parameter indicates if we return required fields.
        :param bool allow_multiple_value_filter_for_taxonomy_fields: This parameter indicates whether multi value
            filtering is allowed for taxonomy fields.
        :param bool audience_target:
        :param bool dates_in_utc: Specifies if the DateTime field is returned in UTC or local time.
        :param bool expand_groups: Specifies whether to expand the grouping or not.
        :param bool expand_user_field:
        :param bool filter_out_channel_folders_in_default_doc_lib:
        """
        self.AddAllFields = add_all_fields
        self.AddAllViewFields = add_all_view_fields
        self.AddRegionalSettings = add_regional_settings
        self.AddRequiredFields = add_required_fields
        self.AllowMultipleValueFilterForTaxonomyFields = (
            allow_multiple_value_filter_for_taxonomy_fields
        )
        self.AudienceTarget = audience_target
        self.DatesInUtc = dates_in_utc
        self.ExpandGroups = expand_groups
        self.ExpandUserField = expand_user_field
        self.FilterOutChannelFoldersInDefaultDocLib = (
            filter_out_channel_folders_in_default_doc_lib
        )

    @property
    def entity_type_name(self):
        return "SP.RenderListDataParameters"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

__init__(self, add_all_fields, add_all_view_fields, add_regional_settings, add_required_fields, allow_multiple_value_filter_for_taxonomy_fields, audience_target, dates_in_utc, expand_groups, expand_user_field, filter_out_channel_folders_in_default_doc_lib)

Purpose: :param bool add_all_fields: :param bool add_all_view_fields: :param bool add_regional_settings: :param bool add_required_fields: This parameter indicates if we return required fields. :param bool allow_multiple_value_filter_for_taxonomy_fields: This parameter indicates whether multi value filtering is allowed for taxonomy fields. :param bool audience_target: :param bool dates_in_utc: Specifies if the DateTime field is returned in UTC or local time. :param bool expand_groups: Specifies whether to expand the grouping or not. :param bool expand_user_field: :param bool filter_out_channel_folders_in_default_doc_lib:

Parameters:

  • add_all_fields: Parameter
  • add_all_view_fields: Parameter
  • add_regional_settings: Parameter
  • add_required_fields: Parameter
  • allow_multiple_value_filter_for_taxonomy_fields: Parameter
  • audience_target: Parameter
  • dates_in_utc: Parameter
  • expand_groups: Parameter
  • expand_user_field: Parameter
  • filter_out_channel_folders_in_default_doc_lib: Parameter

Returns: See docstring for return details

entity_type_name(self) property

Purpose: Performs entity type name

Returns: None

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

# Example usage:
# result = RenderListDataParameters(bases)

Tags

class renderlistdataparameters

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class RenderListDataOverrideParameters 60.4% similar

    A parameter class for overriding SharePoint list data rendering options, inheriting from ClientValue to represent client-side values in SharePoint operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/render_override_parameters.py

  • class GetListsParameters 53.5% similar

    A parameter class for configuring SharePoint list retrieval operations, encapsulating position and row limit settings.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/get_parameters.py

  • class ListItemUpdateParameters 51.1% similar

    A parameter class for updating SharePoint list items, inheriting from ClientValue to represent client-side values in Office 365 operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listitems/update_parameters.py

  • class ListItemDeleteParameters 45.8% similar

    A parameter class that encapsulates configuration options for deleting list items in SharePoint/Office365, specifically controlling whether to bypass shared locks during deletion.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listitems/delete_parameters.py

  • class ODataParameter 45.1% similar

    A simple data class representing an OData parameter with a name and type specification.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/runtime/odata/parameter.py
← Back to Browse