Package com.twilio.rest.ipmessaging.v2.service

Class User

    • Method Detail

      • fetcher

        public static UserFetcher fetcher​(String pathServiceSid,
                                  String pathSid)
        Create a UserFetcher to execute fetch.
        Parameters:
        pathServiceSid - The SID of the Service to fetch the resource from
        pathSid - The SID of the User resource to fetch
        Returns:
        UserFetcher capable of executing the fetch

      • deleter

        public static UserDeleter deleter​(String pathServiceSid,
                                  String pathSid)
        Create a UserDeleter to execute delete.
        Parameters:
        pathServiceSid - The SID of the Service to delete the resource from
        pathSid - The SID of the User resource to delete
        Returns:
        UserDeleter capable of executing the delete

      • creator

        public static UserCreator creator​(String pathServiceSid,
                                  String identity)
        Create a UserCreator to execute create.
        Parameters:
        pathServiceSid - The SID of the Service to create the new resource under
        identity - The `identity` value that identifies the new resource's User
        Returns:
        UserCreator capable of executing the create

      • reader

        public static UserReader reader​(String pathServiceSid)
        Create a UserReader to execute read.
        Parameters:
        pathServiceSid - The SID of the Service to read the User resources from
        Returns:
        UserReader capable of executing the read

      • updater

        public static UserUpdater updater​(String pathServiceSid,
                                  String pathSid)
        Create a UserUpdater to execute update.
        Parameters:
        pathServiceSid - The SID of the Service to update the resource from
        pathSid - The SID of the User resource to update
        Returns:
        UserUpdater capable of executing the update

      • fromJson

        public static User fromJson​(String json,
                            com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON String into a User object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON String
        objectMapper - Jackson ObjectMapper
        Returns:
        User object represented by the provided JSON

      • fromJson

        public static User fromJson​(InputStream json,
                            com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Converts a JSON InputStream into a User object using the provided ObjectMapper.
        Parameters:
        json - Raw JSON InputStream
        objectMapper - Jackson ObjectMapper
        Returns:
        User object represented by the provided JSON

      • getSid

        public final String getSid()
        Returns The The unique string that identifies the resource.
        Returns:
        The unique string that identifies the resource

      • getAccountSid

        public final String getAccountSid()
        Returns The The SID of the Account that created the resource.
        Returns:
        The SID of the Account that created the resource

      • getServiceSid

        public final String getServiceSid()
        Returns The The SID of the Service that the resource is associated with.
        Returns:
        The SID of the Service that the resource is associated with

      • getAttributes

        public final String getAttributes()
        Returns The The JSON string that stores application-specific data.
        Returns:
        The JSON string that stores application-specific data

      • getFriendlyName

        public final String getFriendlyName()
        Returns The The string that you assigned to describe the resource.
        Returns:
        The string that you assigned to describe the resource

      • getRoleSid

        public final String getRoleSid()
        Returns The The SID of the assigned to the user.
        Returns:
        The SID of the assigned to the user

      • getIdentity

        public final String getIdentity()
        Returns The The string that identifies the resource's User.
        Returns:
        The string that identifies the resource's User

      • getIsOnline

        public final Boolean getIsOnline()
        Returns The Whether the User is actively connected to the Service instance and online.
        Returns:
        Whether the User is actively connected to the Service instance and online

      • getIsNotifiable

        public final Boolean getIsNotifiable()
        Returns The Whether the User has a potentially valid Push Notification registration for the Service instance.
        Returns:
        Whether the User has a potentially valid Push Notification registration for the Service instance

      • getDateCreated

        public final org.joda.time.DateTime getDateCreated()
        Returns The The ISO 8601 date and time in GMT when the resource was created.
        Returns:
        The ISO 8601 date and time in GMT when the resource was created

      • getDateUpdated

        public final org.joda.time.DateTime getDateUpdated()
        Returns The The ISO 8601 date and time in GMT when the resource was last updated.
        Returns:
        The ISO 8601 date and time in GMT when the resource was last updated

      • getJoinedChannelsCount

        public final Integer getJoinedChannelsCount()
        Returns The The number of Channels the User is a Member of.
        Returns:
        The number of Channels the User is a Member of

      • getLinks

        public final Map<String,​String> getLinks()
        Returns The The absolute URLs of the Channel and Binding resources related to the user.
        Returns:
        The absolute URLs of the Channel and Binding resources related to the user

      • getUrl

        public final URI getUrl()
        Returns The The absolute URL of the User resource.
        Returns:
        The absolute URL of the User resource

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object