Class ShortCodeReader

    • Constructor Detail

      • ShortCodeReader

        public ShortCodeReader()
        Construct a new ShortCodeReader.
      • ShortCodeReader

        public ShortCodeReader​(String pathAccountSid)
        Construct a new ShortCodeReader.
        Parameters:
        pathAccountSid - The SID of the Account that created the resource(s) to read
    • Method Detail

      • setFriendlyName

        public ShortCodeReader setFriendlyName​(String friendlyName)
        The string that identifies the ShortCode resources to read..
        Parameters:
        friendlyName - The string that identifies the ShortCode resources to read
        Returns:
        this
      • setShortCode

        public ShortCodeReader setShortCode​(String shortCode)
        Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit..
        Parameters:
        shortCode - Filter by ShortCode
        Returns:
        this
      • read

        public ResourceSet<ShortCode> read​(TwilioRestClient client)
        Make the request to the Twilio API to perform the read.
        Specified by:
        read in class Reader<ShortCode>
        Parameters:
        client - TwilioRestClient with which to make the request
        Returns:
        ShortCode ResourceSet
      • firstPage

        public Page<ShortCode> firstPage​(TwilioRestClient client)
        Make the request to the Twilio API to perform the read.
        Specified by:
        firstPage in class Reader<ShortCode>
        Parameters:
        client - TwilioRestClient with which to make the request
        Returns:
        ShortCode ResourceSet
      • getPage

        public Page<ShortCode> getPage​(String targetUrl,
                                       TwilioRestClient client)
        Retrieve the target page from the Twilio API.
        Specified by:
        getPage in class Reader<ShortCode>
        Parameters:
        targetUrl - API-generated URL for the requested results page
        client - TwilioRestClient with which to make the request
        Returns:
        ShortCode ResourceSet